Quick Start
Get up and running with Watchfire in minutes. Initialize a project, create tasks, and start your first AI agent.
Quick Start
This guide walks you through setting up your first Watchfire project, creating tasks, and running an AI agent.
1. Initialize a Project
Navigate to your project directory and initialize Watchfire:
cd your-project
watchfire init
This will:
- Check for git (initialize a repo if missing)
- Create the
.watchfire/directory structure - Create an initial
project.yamlwith a generated UUID - Add
.watchfire/to.gitignore - Prompt you for a project definition and settings
Project Settings
During initialization, you'll configure:
- Auto-merge — Automatically merge completed work to your default branch
- Auto-delete branch — Clean up task branches after merge
- Auto-start tasks — Start the agent when a task is set to ready
- Default branch — The branch to merge completed work into (default:
main)
2. Create Tasks
Add tasks that describe what you want built:
watchfire task add
You'll be prompted to enter:
- Title — A short description of the task
- Prompt — Detailed instructions for the AI agent
- Acceptance criteria — How to verify the task is done
Tasks are stored as YAML files in .watchfire/tasks/:
task_id: a1b2c3d4
task_number: 1
title: "Setup project structure"
prompt: |
Create the initial project structure with...
acceptance_criteria: |
- Directory structure matches spec
- All config files present
status: draft
3. Launch the TUI
Start the interactive TUI to manage tasks and monitor agents:
watchfire
The TUI shows a split view with your task list on the left and the agent terminal on the right:
┌──────────────────────────────────┬──────────────────────────────────┐
│ Task List │ Agent Terminal │
│ │ │
│ Draft (2) │ > Starting session... │
│ #0001 Setup project structure │ │
│ #0002 Implement login flow │ Claude Code v2.1 │
│ │ ~/source/my-project │
│ Ready (0) │ │
│ Done (0) │ > Working on task... │
├──────────────────────────────────┴──────────────────────────────────┤
│ Ctrl+q quit Ctrl+h help Tab switch panel a add s start │
└─────────────────────────────────────────────────────────────────────┘
4. Start an Agent
Select a task and press s to start the agent. Watchfire will:
- Create a git worktree for the task (
watchfire/0001branch) - Spawn Claude Code in a sandboxed PTY inside the worktree
- Stream the agent's terminal output to your TUI
The agent works autonomously, reading the task prompt and acceptance criteria. When it's done, it updates the task file and Watchfire handles the rest.
5. Review and Merge
When a task completes:
- The agent marks the task as
donewithsuccess: true - Watchfire detects the change via file watching
- If auto-merge is enabled, the worktree is merged to your default branch
- The worktree and branch are cleaned up
You can also run all ready tasks sequentially:
watchfire run all
Or enter Wildfire mode for fully autonomous operation:
watchfire wildfire
Next Steps
- Agent Modes — Learn about Chat, Task, Wildfire, and more
- Projects and Tasks — Understand the YAML schemas
- CLI Reference — Full command reference