/** Quickstart guide — Docker, binary, and source install instructions. */ import type { Metadata } from 'next' /** Page metadata for the quickstart guide. */ export const metadata: Metadata = { title: 'Quickstart — Huskies Docs', description: 'Get huskies running in minutes: Docker setup, first story, first agent run.', } /** Renders the quickstart installation and setup guide. */ export default function QuickstartPage() { return ( <>
Get huskies running in your project in a few minutes. This guide covers Docker setup, running from a binary, your first story, and your first agent run.
The easiest way to run huskies is with Docker Compose. This requires Docker and a Claude API key.
docker-compose.yml from the{' '}
releases page or copy it from
the repository's docker/ directory.
.env file next to the compose file:
ANTHROPIC_API_KEY=sk-ant-...
{`volumes:\n - /path/to/your/project:/workspace`}
docker compose up
Open http://localhost:3000 to see the pipeline board.
Download the pre-built binary for your platform from the{' '}
releases page and place it
somewhere on your PATH.
{`curl -L https://code.crashlabs.io/crashlabs/huskies/releases/download/latest/huskies-aarch64-apple-darwin \\
-o /usr/local/bin/huskies
chmod +x /usr/local/bin/huskies`}
{`curl -L https://code.crashlabs.io/crashlabs/huskies/releases/download/latest/huskies-x86_64-unknown-linux-musl \\
-o /usr/local/bin/huskies
chmod +x /usr/local/bin/huskies`}
Requires Rust (stable), Node.js, and npm.
{`git clone https://code.crashlabs.io/crashlabs/huskies
cd huskies
cargo build --release
# Binary is at target/release/huskies`}
From your project directory, run the init command. This creates the .huskies/ directory
with the pipeline structure and configuration files.
{`cd /path/to/your/project\nhuskies init --port 3000`}
This creates:
.huskies/project.toml — project-wide settings
.huskies/agents.toml — agent definitions (coder, QA, mergemaster)
.huskies/work/ — the 6-stage pipeline directory
.mcp.json — MCP server config for Claude Code integration
.huskies/specs/ — placeholder spec files for your project context
.mcp.json file automatically registers
huskies' MCP tools with Claude Code. Open a Claude Code session in your project and it will
discover tools like create_story, start_agent, and{' '}
get_pipeline_status automatically.
huskies --port 3000
Open http://localhost:3000 to see the pipeline board, agent status, and chat interface.
Open a Claude Code session in your project directory (or use the web chat UI), and tell Claude:
help me set up this project with huskies
Claude will walk you through the setup wizard — generating project context (
specs/00_CONTEXT.md), tech stack docs (specs/tech/STACK.md), and
test/release scripts. Review each step and confirm or ask to retry.
In the chat UI or via a chat transport, type:
I want to add a health check endpoint to the API
Claude will create a story file in .huskies/work/1_backlog/ with a user story and
acceptance criteria. Review it, then move it to current:
move <story-number> current
Once a story is in 2_current/, start a coding agent:
start <story-number>
The agent creates an isolated git worktree, implements the feature against the acceptance criteria, runs quality gates (clippy, tests, biome), and exits. The server automatically advances the story to QA if all gates pass.
Once QA passes, the story moves to 4_merge/. To merge:
start <story-number>
The mergemaster agent resolves any conflicts and squash-merges to your main branch. The worktree is cleaned up automatically.
status in the chat at any time to see the current pipeline
state, active agents, and their progress.