CLI
The AgentTeams CLI is built primarily for AI agents to work with the AgentTeams API from the terminal. Agents handle most command-line work — running plans, writing completion reports, and reading co-actions, post-mortems, and code reviews — so people rarely run the CLI directly.
People usually run only two commands:
agentteams init— connect a local repository to a project (one time)agentteams sync— pull the latest conventions from the server
Everything else (plans, reports, co-actions, and more) is used by agents; see the full list in CLI Commands.
Install
Node.js 20.12.0 or newer is required.
npm install -g @agentteams/cliinit — connect a project
Run initialization from the root of your local repository.
agentteams initA browser-based OAuth flow opens, and after authentication the .agentteams/ folder is created. In SSH or remote environments, open the printed URL manually in your browser.
| File | Description |
|---|---|
.agentteams/config.json | API, project, and repository settings |
.agentteams/convention.md | The combined convention file agents read before work |
.agentteams/<category>/*.md | Category-specific convention documents |
.agentteams/ holds credentials, so do not commit it to git.
.agentteamssync — sync conventions
Pull the latest conventions from the server to your local copy. Use it after conventions change on the web to bring your local files up to date.
agentteams sync
The combined convention file (.agentteams/convention.md), platform guides, and category convention documents are downloaded together.
Next steps
After initializing with the CLI, finish Connect a Repository and configure your AI agent to read .agentteams/convention.md before every task. To work plan-first, see Plans; for the full command list, see CLI Commands.