Skip to content

Build and contribute

Public client source is in anytty/anytty. The website and these product docs are in anytty/anytty-site. Cloud services, controllers, edges, deployment, and service integration tests are outside the public client repository.

Build clients

Desktop builds require Go 1.26.5, Node.js 24, and 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 checks additionally require Java 21 and the Android SDK; run make test-android. iOS requires macOS and Xcode; run clients/mobile/ios/scripts/build-ios.sh.

Tool versions and CI checks can move during Beta. Read the repository AGENTS.md, CONTRIBUTING.md, and current CI configuration before changing code.

Build the documentation site

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 prints the local address. GitHub Pages uses the /anytty-site/ base path. Product additions should update both locales, navigation, internal links, and mobile layout.

Contribution contract

  • Open an issue before a large protocol or trust-boundary change.
  • Keep pull requests focused and list validation commands actually run.
  • Sign commits with git commit -s under the DCO.
  • Keep protocol, generated code, tests, user docs, and security assumptions aligned.
  • Update third-party notices when dependencies or bundled assets change.
  • Never contribute credentials, private service source, production configuration, terminal/file content, or user data.

Read the client repository contribution guide, code of conduct, governance policy, and security policy.

Documentation and screenshots

Use public source, current CLI help, and reproducible UI as product facts. Capture with synthetic endpoints and data, then inspect usernames, hostnames, addresses, claims, grants, paths, and terminal output. Keep an explicit asset placeholder when a real screen is unavailable; do not present a conceptual mock as a product screenshot.