Skip to content

Quick start

Establish the local workflow first: install the CLI, start the current-user daemon, and create a reconnectable terminal. Add mobile and remote routes after the local checks pass.

1. Install desktop AnyTTY

macOS or Linux:

curl -fsSL https://raw.githubusercontent.com/anytty/anytty/main/install.sh | sh

Windows PowerShell:

Invoke-WebRequest https://raw.githubusercontent.com/anytty/anytty/main/install.ps1 -OutFile install.ps1
.\install.ps1

The installers select the matching release and verify SHA-256. Open a new shell and check:

anytty --version

See Install, upgrade, and uninstall for platform status and manual installation.

2. Start the daemon

anytty daemon start
anytty daemon status

The daemon runs as the current user and owns terminals, history, files, identity, and grants. On failure:

anytty daemon doctor
anytty daemon logs --lines 100

3. Open the TUI

anytty

Create a terminal in the TUI, or create and attach directly:

anytty terminal create --name workspace --attach -- zsh

On Windows, replace zsh with an installed shell such as pwsh.exe. Closing the TUI does not stop the process; reopen anytty or use anytty attach TERMINAL to resume it.

4. Check terminal state

anytty terminal list
anytty terminal show workspace

Names are for navigation; stable IDs survive renames. Use tags for organization and events or wait for lifecycle automation. See Terminals and TUI.

5. Pair a mobile client

anytty pair create

Scan the QR code or paste the text claim in the app. The default claim lifetime is 10 minutes and it can be redeemed once. Never publish it in chat, an issue, or a screenshot.

Cloud sign-in does not automatically synchronize daemon access. Every client needs explicit pairing. Continue with Mobile and tablet and Pairing and access.

6. Reach another machine

  • Prefer SSH when trusted host access already exists.
  • Use Direct on a controlled reachable network and limit the listener address.
  • Use Cloud when Internet discovery, P2P negotiation, or Relay fallback is needed.
  • Local is the current-machine path and does not use a network service.

Configure Endpoints and connections and test each path with anytty endpoint test ID --route ROUTE.

Completion check

anytty --version
anytty config validate
anytty daemon status
anytty terminal list
anytty endpoint list

Next, read Understand AnyTTY or go directly to Files and preview.