Using the Clients
AgentTeams splits one workflow across several clients. The web app is the center for review and operations. The CLI works from a local repository. The desktop app combines the web app with screen capture. The VS Code extension keeps AgentTeams context visible inside the editor.
| Client | Primary use | Start here |
|---|---|---|
| Web | Select projects, review plans/reports/conventions/runner requests, operate workspaces | Web |
| CLI | Initialize a repo, sync conventions, manage plans/reports/co-actions/post-mortems | CLI |
| Desktop | Use the web app plus screen-region capture, annotation, and pinned project tabs | Desktop |
| Extension | View plans, reports, post-mortems, and conventions in VS Code | Extension |
Which client should I start with?
For first-time setup, follow the 5-Minute Quickstart, initialize the CLI, then review your project in the web app. Add other clients based on how you work.
- Run
agentteams initin your local repository to create.agentteams/config.jsonand.agentteams/convention.md. - Use the web app to confirm your team, project, repositories, and runners.
- Configure your AI agent to always read
.agentteams/convention.md. - Use the CLI or VS Code extension for repeated local work, and desktop for screen-capture requests.
How the clients connect
All clients use the same AgentTeams API and project context. The CLI and VS Code extension read local .agentteams/config.json; web and desktop use a signed-in session.
Scope of this section
This section explains how to use each client. For the full command list, see CLI Commands. For entity-level workflows such as plans, completion reports, and co-actions, see Core Workflows.