LanguageEN繁
Home
Docs
Get Started / Quick Start

Quick Start

Run your first Heddle session, inspect a real repository, and open the browser review surface.

1. Install the CLI

Terminal
npm install -g @roackb2/heddle

2. Configure provider access

Use OpenAI account sign-in for a quick local setup, or provide an OpenAI or Anthropic API key from your shell.

Terminal
heddle auth login openai
# or
export OPENAI_API_KEY="your_key"
export ANTHROPIC_API_KEY="your_key"

3. Start a session

2-Minute Try-It Path
cd /path/to/your/project
heddle
# → "Summarize this repo and show the main entrypoints."

# One-shot alternative:
heddle ask "List the main build and test commands"

4. Open the browser control plane

The daemon serves Heddle's local browser control plane. Use it to inspect saved sessions, review current Git diffs, watch live run status, check memory health, and manage heartbeat tasks.

Terminal
heddle daemon
# open http://127.0.0.1:8765 from the daemon output

Useful first prompts

Summarize this repository, identify the main entrypoints, and list build/test commands.
Find the highest-risk TODOs or failing tests and propose a safe first fix.
Review the current git diff and tell me what should be verified before commit.

What you should see

  • The terminal UI streams assistant text, tool activity, plans, and approval waits.
  • Runs are saved as sessions under .heddle/ for later continuation and review.
  • Browser Sessions can show the same conversation and current workspace diff.
  • Memory candidates may be recorded when Heddle notices durable project facts or preferences.

What's next?