Quick Start

Install, sign in, and run your first turn in under a minute.

1. Launch in your project

The current working directory is the workspace root — agentty's filesystem tools won't touch anything outside it.

cd path/to/your/project
agentty⧉

2. Sign in

First launch opens an auth modal. Pick one:

• OAuth (Claude Pro/Max) — opens your browser; the callback writes the token to ~/.config/agentty/credentials.json (mode 0600).
• API key — paste an sk-ant-… token, saved to the same file.

3. Your first turn

Type a request, hit Enter. agentty streams the reply and lands tool calls inline. Mid-stream typing queues your next message and sends it when the current turn finishes. Esc cancels.

▌ add a --version flag that prints the build version and exits⧉

4. Pick a permission profile

You start in Ask — writes, shell calls, and network calls each prompt before running. Press S-Tab to cycle to Write (autonomous) or Minimal (prompts for everything but pure reads). Your choice persists.

Where to go next

• The Interface — what every part of the screen means.
• Keybindings — the full keymap.
• Tools — what agentty can actually do.
• SSH Air-gap — run on a box with no internet.