Skip to content

AnyTTY documentation overview

This is the complete entry point for the AnyTTY product documentation. The guides focus on installation, connections, terminals, files, and cross-device workflows. Protocol implementation and internal service architecture are outside their scope. Commands, defaults, platform status, and security boundaries are checked against public source and the current CLI.

Suggested reading paths

  • First-time setup: Product introduction -> Install and upgrade -> Quick start -> Terminals and TUI
  • AI coding tasks: AI agent workflows -> Observe and take over -> Review history
  • Mobile terminal access: Mobile clients -> Pairing and permissions -> Connection routes
  • Remote machines: Endpoints and connections -> Direct / SSH / Cloud -> Connection troubleshooting
  • Long-running deployments: Configuration and operations -> Security and privacy -> Troubleshooting

1. Understand AnyTTY

  • Product purpose, suitable use cases, and non-goals
  • Supported platforms, clients, and current Beta limitations
  • How daemons, clients, terminals, workspaces, and panels relate
  • Endpoints, routes, pairing claims, and grants
  • Live views, history, and resuming work from another client

2. Install, upgrade, and uninstall

  • Installation on macOS, Linux, and Windows
  • Obtaining the Android and iOS clients
  • Starting the daemon and checking the environment
  • Upgrades, downgrades, migrations, and compatibility
  • Uninstalling while preserving or removing local data

Start with Quick start.

3. Terminals and desktop workflows

  • Creating, naming, attaching, detaching, stopping, and removing terminals
  • TUI navigation, the terminal picker, and common actions
  • Workspaces, splits, panels, and floating panels
  • Terminal status, recent activity, and background tasks
  • Live output, history browsing, search, and restoring context
  • Using the CLI and TUI together

Start with Terminal management.

4. AI agent workflows

  • Use the AnyTTY skill to define how an AI creates and manages task terminals
  • Place long-lived, parallel, and takeover-ready work in the terminal pool
  • Organize tasks with names and kind, agent, project, run, and task tags
  • Inspect each task’s command, state, output, events, and exit result
  • Observe and take over the same task from the TUI, CLI, or a mobile client
  • Search retained history and reconstruct a task session

5. Mobile and tablet clients

  • Adding a device and making the first connection
  • Terminal lists, state, and recent activity
  • Touch controls, extra keys, and input methods
  • Backgrounding, reconnection, and moving between devices
  • Split-screen and multitasking workflows on tablets
  • Local storage, permissions, and mobile security settings

6. Endpoints and connection routes

  • Endpoints, routes, and local selection policy
  • Differences between Local, SSH, Direct, and Cloud
  • Adding, inspecting, editing, and removing endpoints
  • Route priority, fallback, and failure behavior
  • NAT, firewall, proxy, and enterprise network requirements
  • Latency, connection quality, and path diagnostics

Start with Connection routes.

7. Pairing, authorization, and device management

  • Generating a QR or text pairing claim
  • Scanning, pasting, and one-time redemption
  • Terminal and file permissions
  • Inspecting, narrowing, and revoking grants
  • Replacing a phone and responding to a lost device or credential
  • Diagnosing failed pairing, clock skew, and expired claims

Start with QR pairing.

8. File management and preview

  • File roots and least-privilege configuration
  • Browsing, searching, creating, renaming, and deleting
  • Uploads, downloads, cancellation, and integrity checks
  • Opening files from a terminal’s working directory
  • Previewing text, documents, images, media, and 3D files
  • Large files, interrupted networks, and transfer failures

Start with File management.

9. AnyTTY Cloud

  • What Cloud solves and how it relates to the open-source clients
  • Sign-up, sign-in, device discovery, and account management
  • P2P negotiation, Relay fallback, and connection state
  • Choosing between Cloud, Local, SSH, and Direct
  • Service limits, usage, plans, and billing
  • Closing an account, removing devices, and data handling

Start with AnyTTY Cloud.

10. Configuration and operations

  • Daemon configuration files, flags, and environment variables
  • Starting at login, stopping, restarting, and checking status
  • History, logs, caches, and disk usage
  • Maintaining file roots and access policy
  • Backup, restore, and device migration
  • Performance, resource limits, and long-running operation

11. Security and privacy

  • Responsibility boundaries between clients, daemons, routes, and Cloud
  • Authentication, transport encryption, and credential storage
  • Pairing claims, grants, and revocation
  • What a Relay can observe and which permissions it cannot obtain
  • Handling terminal content, files, logs, and diagnostics
  • Security checklist and vulnerability reporting

Start with the Security model.

12. Troubleshooting

  • Commands missing after installation or a daemon that will not start
  • TUI rendering, keyboard input, and terminal sizing problems
  • Mobile scanning, pairing, or reconnection failures
  • SSH, Direct, P2P, or Relay connection failures
  • File listing, preview, upload, or download failures
  • Collecting redacted diagnostics and getting support

13. Frequently asked questions

  • Closing the TUI versus stopping a task or deleting its record
  • How AI tasks enter and remain observable in the terminal pool
  • Boundaries between Cloud sign-in, pairing, routes, and Relay
  • Multiple clients, resize ownership, history, and file permissions
  • Configuration paths, runtime defaults, and the recommended profile

14. Command and configuration reference

  • CLI command index
  • Daemon, terminal, endpoint, pair, and file commands
  • Configuration fields and examples
  • Environment variables, default ports, and data directories
  • Status values, error codes, and log fields
  • Platform support matrix, compatibility, and glossary

15. Releases, support, and contributing

  • Beta stability commitments and known limitations
  • Release notes, upgrade notes, and compatibility policy
  • Getting help, filing issues, and suggesting features
  • Privacy questions and security vulnerability reports
  • Building from source and contributing code or documentation

Developers and contributors can start with Build and contribute.