跳到正文

构建与贡献

AnyTTY 客户端源码位于公开的 anytty/anytty 仓库；官网和本产品文档位于 anytty/anytty-site。Cloud 服务、controller、edge、部署和服务集成测试不属于公开客户端仓库。

构建客户端

桌面构建要求 Go 1.26.5、Node.js 24 和 npm：

git clone https://github.com/anytty/anytty.git
cd anytty
npm ci
make build
make test
make test-clients
npm run public:check

Android release 检查还需要 Java 21 和 Android SDK，执行 make test-android。iOS 需要 macOS 与 Xcode，执行 clients/mobile/ios/scripts/build-ios.sh。

仓库里的具体工具版本和 CI 命令可能随 Beta 更新；开始修改前应再阅读仓库根目录的 AGENTS.md、CONTRIBUTING.md 和 CI 配置。

构建文档站

git clone https://github.com/anytty/anytty-site.git
cd anytty-site
npm ci
npm run site:build
npm run site:check
npm run site:preview

Astro 会打印本地地址；GitHub Pages 部署使用 /anytty-site/ base path。新增产品能力时，应同时更新中文、英文导航与对应文章，并检查站内链接和移动端布局。

贡献约定

  • 大型协议或信任边界变更应先创建 issue。
  • pull request 保持单一范围，并列出实际执行过的验证命令。
  • 使用 git commit -s 按 DCO 签署提交。
  • 协议、生成代码、测试、用户文档和安全假设必须同步更新。
  • 依赖或打包资产变化时更新第三方声明。
  • 不得贡献凭据、私有服务源码、生产配置、真实 terminal/file 内容或用户数据。

继续阅读客户端仓库的贡献指南、行为准则、治理政策和安全政策。

文档与截图

产品文档应以公开源码、当前 CLI --help 和可复现 UI 为事实来源。截图使用专门的测试 endpoint 和虚构数据，提交前检查主机名、用户名、IP、claim、grant、路径和终端输出。缺图时保留明确的素材路径与拍摄说明，不用概念图冒充真实产品界面。