Back to docs
5 minutes to first output

Getting Started

From zero to running your first AI agent. No prior experience needed.

Before you start

Node.js 18+ required — nodejs.org
Claude Code required executor — claude.ai/code
Git required — for agent memory and activity tracking

Claude Code executor: squads-cli uses Claude Code to run agents locally. Make sure it's installed and authenticated with your Anthropic API key before proceeding.

1

Install squads-cli

terminal
$ npm install -g squads-cli
expected output
added 42 packages in 3s
[email protected] installed

Verify the install: squads --version

2

Initialize a project

Navigate to your project directory (or create a new one), then run:

terminal
$ squads init
expected output
✓ Created .agents/squads/ directory
✓ Created example squad: engineering
✓ Created .agents/memory/ directory
✓ Created .agents/sessions/ directory
Ready. Run your first agent:
$ squads run engineering -a backend-engineer -e
What was created:
.agents/
squads/
engineering/
SQUAD.md # Squad config + goals
backend-engineer.md # Agent definition
frontend-engineer.md
memory/ # Persistent agent memory
sessions/ # Session history
3

Run your first agent

The -e flag runs the agent immediately (non-interactive). This is the fastest way to see results.

terminal
$ squads run engineering -a backend-engineer -e
expected output
Starting session: backend-engineer (engineering)
Executor: claude-code
Memory: .agents/memory/engineering/backend-engineer/
› Reading SQUAD.md goals...
› Loading agent context...
› Agent running...
✓ Session complete
Output saved to .agents/sessions/

What just happened: squads-cli read your SQUAD.md goals, loaded the backend-engineer agent definition, and ran it via Claude Code. The agent acted on your goals and saved output to memory.

4

Set a goal and re-run

Edit .agents/squads/engineering/SQUAD.md and add a real goal for your project. Then run the agent again — it reads your goals every time.

.agents/squads/engineering/SQUAD.md
## Goals
- Write unit tests for the auth module
- Review and document the API endpoints
terminal
$ squads run engineering -a backend-engineer -e