Skip to main content

AI Agents

Sprout runs AI coding agents in dedicated tmux windows within each worktree's session. The TUI keeps the worktree list, agent status, and git diff review pane together while tmux remains the full interactive workspace.

Use sprout agent attach or sprout go when you want the full live tmux workspace. Use the TUI when you want to review several agent sessions on one repo from a single board.

Supported agents​

  • Codex: npm install -g @openai/codex
  • Aider: pip install aider-chat
  • Claude Code: see claude.ai/code
  • Gemini: see Google's Gemini CLI docs
  • Custom: any CLI tool you configure

Configuration​

default_agent_type = "claude"
auto_start_agent = true

agent_command_codex = "codex"
agent_command_aider = "aider --model gpt-4"
agent_command_claude = "claude"
agent_command_gemini = "gemini"

Usage​

Agents start automatically when auto_start_agent = true. To control them manually:

sprout agent start feat/my-feature
sprout agent attach feat/my-feature
sprout agent stop feat/my-feature

Agents stop automatically when you remove a worktree.

TUI agent status​

The main worktree table includes a dedicated AGENT column.

  • AGENT shows whether the selected worktree agent is busy, ready, needs input, offline, or unavailable.

Main agent actions:

  • enter or g: attach to the worktree tmux session
  • p: promote the selected worktree to preview

The detail pane stays focused on git diff and review context. Agent interaction happens in tmux.

API keys​

Set the relevant key for your agent:

export OPENAI_API_KEY="..."
export ANTHROPIC_API_KEY="..."

Add to ~/.zshrc (or equivalent) to persist.