Getting started

Quick start

Get Mode Agent running in under 60 seconds. Install, authenticate, and start your first multi-agent session.

It is a CLI tool that orchestrates multiple AI agents working in parallel. Each agent has a specialized role (coder, designer, researcher, marketer) and they communicate through a shared signal bus.

Prerequisites You need a Mode account (any plan) and a terminal. That's it. No API keys, no Docker, no dependencies.

Get started in 3 steps

  1. Install Mode Agent
  2. Authenticate by running mode
  3. Start Mode Agent and describe your task

Ready? Start with Installation.

Getting started

Installation

Install Mode Agent with a single command.

Quick install

bash
curl -fsSL https://gotmode.sh | sh

Verify

bash
mode --version
0.0.1
Tip Mode Agent handles all model routing automatically. No API keys needed. Your account includes access to all supported models.

Up next, Authenticate.

Getting started

Authenticate

Mode Agent authenticates you the first time you run it.

bash
mode

The first time you run mode, it opens your browser for magic link authentication. Once you confirm, the CLI is authenticated and ready to use. You won't need to authenticate again on this machine.

Up next, First session.

Getting started

First session

Start Mode Agent and describe your first task.

Type mode to enter an interactive session.

bash
mode

Once inside the session, describe what you want to accomplish. The Agent reads your goal, deploys the right agents, and they execute in parallel.

The Agent will do the following.

  1. Decompose your goal into tasks
  2. Assign each task to a specialized agent
  3. Execute agents in parallel
  4. Deliver tested, ready-to-ship results

What happens under the hood

The planner agent reads your goal, decides which agent roles are needed, and coordinates execution. For a "Build a REST API" task, it might spawn the following agents.

  • architect designs the system structure
  • coder:1 implements the API routes
  • coder:2 implements authentication
  • tester writes tests as code is produced

All running simultaneously, communicating through signals.

Core concepts

Agents

Mode Agent spawns specialized agents for each role in your workflow. Each agent has a specific job, an auto-routed model, and runs inside a sandboxed environment.

Built-in agent roles

It ships with agent roles across every business domain. The orchestrator auto-routes each agent to the optimal model based on task type, cost, and latency.

Engineering

RoleResponsibility
plannerBreaks goal into tasks, coordinates all agents, manages execution order
architectReviews codebase, designs system structure, evaluates trade-offs
coderImplements features and writes code (runs in parallel, multiple instances)
testerWrites and runs unit/integration tests, validates coverage, reports failures
qaEnd-to-end validation, regression testing, edge case discovery
reviewerReviews diffs, enforces standards, gates submission
securityVulnerability scanning, dependency audits, OWASP checks, secrets detection
devopsCI/CD configuration, deployment scripts, infrastructure-as-code
debuggerTraces errors, analyzes logs, isolates root causes
docsTechnical documentation, API references, READMEs, changelogs

Product

RoleResponsibility
productDrafts PRDs, prioritizes backlogs, defines requirements
analystAnalyzes usage data, identifies trends, generates reports
strategistCompetitive analysis, market positioning, pricing strategy

Design

RoleResponsibility
designerGenerates UI components, layouts, and design system tokens
prototyperInteractive prototypes, click-through mockups, user flow wireframes
ux-writerMicrocopy, error messages, onboarding flows, and in-app text

Marketing & Sales

RoleResponsibility
copywriterLanding pages, blog posts, brand voice copy, content calendars
adsPaid campaign creative, A/B ad variants, audience targeting
socialSocial media content, platform-native formats, scheduling
emailDrip campaigns, nurture sequences, newsletters
seoKeyword research, meta tags, structured data, content optimization
outreachSales sequences, cold email, proposal generation, pitch decks

Research

RoleResponsibility
researcherMarket research, competitive intelligence, trend discovery
dataQuantitative analysis, SQL queries, data visualization
councilLLM Council that convenes multiple models to deliberate critical decisions

Operations

RoleResponsibility
commsStakeholder updates, release announcements, internal notifications, channel posts
supportKnowledge base articles, ticket responses, FAQ generation
financeInvoice processing, expense reports, financial projections

Mode Agent auto-routes each agent to the optimal model. No configuration needed.

Core concepts

Orchestration

The planner agent coordinates all other agents through a shared signal bus.

Execution model

  1. You describe your goal and Mode Agent deploys agents
  2. The planner decomposes it into tasks and assigns them to agents
  3. Agents execute in parallel, emitting signals as they work
  4. The reviewer validates diffs and ships tested results

Parallel execution

Unlike sequential AI tools, the Agent runs multiple agents simultaneously. The planner identifies independent tasks and launches them in parallel, only serializing when there are true dependencies.

Model routing

Each agent is automatically routed to the optimal model based on several factors.

  • Task type means code tasks route to code-optimized models
  • Cost means simple tasks use cheaper models
  • Latency means time-sensitive tasks route to faster models

Model routing is fully automatic. No configuration needed.

Core concepts

Signals

Agents communicate by emitting and subscribing to typed signals, not by calling each other directly.

How signals work

Every agent action produces a signal on the shared bus. Other agents can subscribe to specific signal types to coordinate their work.

signal
[coder:1] emit file.created  src/auth/middleware.ts
[tester]  recv file.created  → generating tests for middleware.ts
[reviewer] recv file.created → queued for review

Signal types

SignalEmitted when
task.startedAn agent begins work on a task
task.completedAn agent finishes a task
file.createdA new file is created
file.modifiedAn existing file is changed
test.passedA test suite passes
test.failedA test suite fails
review.approvedChanges are approved by reviewer
errorAn agent encounters an error

View signals in real-time with mode logs --follow.

Core concepts

Permissions

Mode Agent runs every agent in a sandboxed environment. You define the boundaries once in your config and agents operate freely within them. No permission prompts, no interruptions.

json
{
  "permissions": {
    "fs": {
      "roots": ["./src", "./test"],
      "deny": [".env", "secrets/**"]
    },
    "bash": {
      "allow": ["git", "npm", "make"]
    }
  }
}
Security Anything outside the sandbox is simply invisible to agents. They cannot escalate their own boundaries.

File system sandbox

fs.roots defines the directories that make up the sandbox. Agents can read and write freely inside these roots. Everything else is invisible.

fs.deny carves out exclusions within the sandbox for secrets, credentials, and sensitive config.

Command sandbox

bash.allow defines which shell commands agents can execute inside the sandbox. Pipes and subshells that would reach outside the sandbox are blocked automatically.

See Configuration: Permissions for the full reference.

CLI reference

mode

Start Mode Agent. Authenticates automatically on first run.

bash
mode

Starts an interactive Mode Agent session. If this is your first time, it opens your browser for magic link authentication. Once authenticated, you're taken straight into the session.

CLI reference

mode logs

Stream or replay agent signals from a run.

bash
mode logs [run-id]          # Replay signals for a run
mode logs --follow           # Stream live signals from current run
mode logs --agent coder:1    # Filter to one agent
CLI reference

mode stop

Stop a running agent or an entire run.

bash
mode stop                    # Stop all agents in current run
mode stop --agent coder:2    # Stop a specific agent
mode stop --run abc123       # Stop a specific run by ID
Configuration

Config file

Place .mode/config.json in your project root. Mode Agent reads this file automatically on every session.

json
{
  "permissions": {
    "fs":   { "roots": ["./src", "./test"] },
    "bash": { "allow": ["git", "npm", "make"] }
  },
  "tmux": { "enabled": true, "layout": "tiled" }
}

The Agent auto-routes all models. The config file is for permissions and display preferences only.

Configuration

Permissions config

Full reference for the sandbox configuration block. Define the boundaries once and agents operate freely within them.

KeyTypeDescription
fs.rootsstring[]Directories that form the file system sandbox
fs.denystring[]Glob patterns excluded from the sandbox
bash.allowstring[]Shell commands available inside the sandbox
bash.denystring[]Commands excluded even if listed in allow
net.allowstring[]Outbound hostnames reachable from the sandbox
net.denystring[]Outbound hostnames blocked from the sandbox
Deny takes priority. If a path or command appears in both allow and deny, it is excluded from the sandbox.
API reference · Coming soon

REST API

The Mode Agent REST API will let you start runs, stream signals, and manage agents programmatically.

Coming soon. The REST API is not live yet. The endpoints, base URL, and examples below are a preview of the planned interface. They are not callable today, so do not wire them into anything until we announce availability.

Base URL

The base URL will be published here when the API goes live. There is no live endpoint to call yet.

Planned endpoints

MethodPathDescription
POST/v1/runsStart a new agent run
GET/v1/runs/:idGet run status and results
DELETE/v1/runs/:idStop a run
GET/v1/runs/:id/signalsStream signals (SSE)
GET/v1/agentsList available agent roles

See Authentication to get started.

API reference · Coming soon

Authentication

How API requests will authenticate once the REST API is live.

Coming soon. This is a preview of the planned auth flow. There is no API to call yet, so generated keys cannot authenticate against anything today.

Requests will pass your API key in the Authorization header, in this form.

bash
Authorization: Bearer sk_mode_xxxxxxxxxxxx

API keys will be generated from your dashboard, scoped with specific permissions and rate limits.

Keep it secret. Never expose your API key in client-side code or version control.
API reference · Coming soon

Runs

How you will create and manage multi-agent runs via the API.

Coming soon. The endpoints below describe the planned interface. They are not live, so there are no runnable examples yet. We will add request and response samples here when the API ships.

POST /v1/runs

Will start a new agent run from a goal and an optional set of agent roles.

GET /v1/runs/:id

Will return the status and results of a run.

API reference · Coming soon

Agents

How you will list and inspect available agent roles.

Coming soon. This endpoint is not live yet. The response shape below is a preview of the planned interface.

GET /v1/agents

Will return all available agent roles and their default models.

Planned response

json
{
  "agents": [
    { "role": "planner", "model": "auto", "parallelizable": false },
    { "role": "coder", "model": "auto", "parallelizable": true },
    { "role": "tester", "model": "auto", "parallelizable": true }
  ]
}