5-Minute Quickstart

AgentTeams is a development workflow platform for working alongside AI agents. This page shows the shortest path from a local repository to an initialized AgentTeams project, an agent convention file, and your first plan.

Runner is not required for this quickstart. Start with the CLI and a local AI agent first; add Runner Installation later when you want web requests to be picked up and executed automatically.

Before you start

An AgentTeams web account — sign up, then sign in and create your first project. CLI authentication links to this account.
Install Node.js 20.12.0+ (node -v).
One AI agent CLI — the agent that actually runs the work must be installed locally and signed in. Set up one of the following.

Agent	Command	Install
Claude Code	`claude`	code.claude.com/docs
Codex	`codex`	developers.openai.com/codex/cli
Copilot CLI	`copilot`	Install GitHub Copilot CLI
Cursor CLI	`agent`	Cursor CLI
OpenCode	`opencode`	opencode.ai/docs
Antigravity	`agy`	antigravity.google/docs/cli-install
AmpCode	`amp`	ampcode.com
Kimi CLI	`kimi`	Kimi Code

Step 1: Install the CLI


npm install -g @agentteams/cli

Step 2: Initialize

Run the following command in your local repository root.


agentteams init

A browser window will open for authentication. Complete the process on the CLI page in the web app.

After authentication, .agentteams/ is created. The important files are:

File	Description
`.agentteams/config.json`	API configuration used by the CLI and VS Code extension.
`.agentteams/convention.md`	The combined convention file your AI agent should read before work.
`.agentteams/<category>/*.md`	Category-specific convention documents downloaded from the server.

Add .agentteams/ to .gitignore; it can contain credentials.

Step 3: Connect your AI agent convention file

To connect an AI agent to AgentTeams, configure the agent’s convention file to reference .agentteams/convention.md.

Add the following content to the agent convention file.


---
alwaysApply: true
---

# AGENT_RULES

**Before starting any task, always refer to `.agentteams/convention.md`.**

AI agent	Convention file
Claude Code	`CLAUDE.md`
OpenCode · Codex · Antigravity · Copilot CLI · Cursor CLI · Kimi CLI	`AGENTS.md`
Cursor	`.cursor/rules/agentteams.mdc`

Next steps

A Set Up Project Conventions plan is already registered when you create a project. Instead of creating one, just ask your agent to start it to set up your first conventions. See Conventions for details.

Try saying something like this to your AI agent:

Analyze the codebase and create conventions.
Create a plan to improve test coverage for this project.
Find ways to optimize API response times and register them as a plan.

Review the plans your AI agent creates on the web. If you like one, tell your agent Start plan {plan ID}!

When the work is done, write a completion report so the result and verification evidence are reviewable. If the work exposed a reproducible or systemic failure, create a post-mortem separately and register the prevention rule as a convention.