Installation

Install Agentty, launch your first session, and review generated changes.

Install agentty, authenticate an agent backend, and launch your first session.

Install🔗

npm (recommended), Bun, and pnpm global installs support automatic updates when Agentty can identify the original package manager. These packages require Node.js on your PATH.

$npm install -g agentty

.install-tabs,.install-command .copy-btn{display:none}.install-fallback pre{white-space:pre-wrap;overflow-wrap:anywhere}

Other installation methods

Bun

bun add --global agentty

pnpm

pnpm add --global agentty

npx (run without installing)

npx agentty

Cargo

cargo install agentty

Shell installer

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/agentty-xyz/agentty/releases/latest/download/agentty-installer.sh | sh

If pnpm reports a global bin-directory error, run pnpm setup, reopen your terminal, and retry.

If package install scripts are blocked, the first launch downloads the binary from GitHub Releases. Keep network access available for that launch.

To update manually, use the same method you originally installed with:

Method	Update command
npm	`npm install --global agentty@latest`
Bun	`bun add --global agentty@latest`
pnpm	`pnpm add --global agentty@latest`
Cargo	`cargo install agentty --locked`
Shell	Rerun the shell installer above.

With npx, run npx agentty@latest to use the latest release without a global install.

For Cargo installation on macOS, install Xcode Command Line Tools for native process bindings.

Verify a GitHub Release

Install the GitHub CLI, then download a GitHub release artifact. Each artifact has keyless Sigstore build provenance that identifies Agentty's release workflow:

gh attestation verify PATH_TO_ARTIFACT --repo agentty-xyz/agentty

Release immutability also protects the published tag and complete asset set. Verify a specific release and a downloaded asset with:

gh release verify vX.Y.Z --repo agentty-xyz/agentty
gh release verify-asset vX.Y.Z PATH_TO_ARTIFACT --repo agentty-xyz/agentty

Prepare an Agent Backend🔗

Agentty also requires at least one supported agent CLI on your PATH. Install and authenticate one backend before launching Agentty:

Codex (codex, recommended; supports subscription usage): install the Codex CLI, then run codex login.
Claude (claude): install Claude Code, then run claude auth login.
Antigravity (agy 1.1.18 or newer): install the Antigravity CLI, then run agy and follow its sign-in flow.
Gemini (gemini): install the Gemini CLI, then configure an API key or Vertex AI authentication.

See Agents & Models before choosing credentials. Provider subscription and OAuth rules differ, and not every interactive CLI sign-in is suitable for third-party invocation through Agentty.

Start a Session🔗

Agentty automatically discovers Git repositories under your home directory.

Run agentty from any directory.
In the Projects tab, select a repository and press Enter.
In the Sessions tab, press a and choose Regular.
Type your first prompt and press Enter to start the agent.
Let the agent modify files in its dedicated worktree branch.

Only one Agentty instance can use a given Agentty root at a time. If startup reports that another instance is running, close that instance first. A crash releases ownership automatically; do not delete the lock file. Separate AGENTTY_ROOT directories can run independently.

Review Changes🔗

Inside agentty, open the diff view (d) to inspect the generated git diff before you keep or discard edits.

Next Steps🔗

Overview — understand sessions, projects, and worktree isolation.
Workflow — learn how to create, review, and finish sessions.