⚠️

You're viewing documentation for Sugar V2 (Legacy)

Sugar V3 with Claude Agent SDK integration is now available. View V3 docs →

Version:
← All V2 Docs

Quick Start Guide

Get Sugar up and running in your project in just a few minutes.

Prerequisites

Before installing Sugar, make sure you have:

  • Python 3.11 or higher
  • Claude Code CLI installed (installation guide)
  • Git (for project management)

Install Claude Code CLI

# Install via npm (recommended)
npm install -g @anthropic-ai/claude-code

# Verify installation
claude --version

Installation

pip install sugarai

Or use uv for faster installation: uv pip install sugarai

Basic Usage

1. Initialize Sugar in Your Project

Navigate to your project directory and initialize Sugar:

cd /path/to/your/project
sugar init

This creates a .sugar/ directory with configuration and database.

2. Add Your First Task

Add tasks to the queue with priorities and types:

# Add a feature task
sugar add "Implement user authentication" --type feature --priority 4

# Add an urgent bug fix
sugar add "Fix memory leak in auth module" --type bug_fix --urgent

# Add a test task
sugar add "Add unit tests for payments" --type test --priority 3

3. Check Status

# View system status
sugar status

# List all tasks
sugar list

# View specific task details
sugar view TASK_ID

4. Run Sugar

# Test run (safe mode - no actual changes)
sugar run --dry-run --once

# Start continuous autonomous development
sugar run

Sugar will pick up tasks from the queue and execute them autonomously.

Configuration

Edit .sugar/config.yaml to customize Sugar for your project:

sugar:
  # Core settings
  dry_run: true  # Set to false when ready for real execution
  loop_interval: 300  # 5 minutes between cycles
  max_concurrent_work: 3

  # Claude CLI path (auto-detected)
  claude:
    command: "/path/to/claude"
    timeout: 1800  # 30 minutes max per task

  # Work discovery
  discovery:
    error_logs:
      enabled: true
      paths: ["logs/errors/"]

    code_quality:
      enabled: true
      source_dirs: ["src", "lib", "app"]
Safety First: Sugar starts in dry-run mode by default. Set dry_run: false when ready for autonomous operation.

Tips

  • Start Small: Begin with --dry-run --once to see what Sugar would do
  • Monitor Logs: Check .sugar/sugar.log for detailed activity
  • Project Isolation: Each project gets its own Sugar instance
  • Run in Terminal: Run Sugar in a regular terminal, not within a Claude Code session

Next Steps