Skip to Content
Using the ClientsOverview

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.

ClientPrimary useStart here
WebSelect projects, review plans/reports/conventions/runner requests, operate workspacesWeb
CLIInitialize a repo, sync conventions, manage plans/reports/co-actions/post-mortemsCLI
DesktopUse the web app plus screen-region capture, annotation, and pinned project tabsDesktop
ExtensionView plans, reports, post-mortems, and conventions in VS CodeExtension

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.

  1. Run agentteams init in your local repository to create .agentteams/config.json and .agentteams/convention.md.
  2. Use the web app to confirm your team, project, repositories, and runners.
  3. Configure your AI agent to always read .agentteams/convention.md.
  4. 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.

Last updated on