Skip to content

quickstart.md

Latest commit

 

History

History
36 lines (24 loc) · 1.27 KB

quickstart.md

File metadata and controls

36 lines (24 loc) · 1.27 KB
Raw

Quickstart

1. Install the runner

uv sync --extra dev
uv run research-loop --help

2. Prepare a target

Use an existing project with at least one commit. Setup may inspect dirty state, but plan, prepare, and execute require the base checkout to be clean.

uv run research-loop inspect --repo /path/to/project

Give the inspection result, the user's exact goal, and verified project evidence to the Research Loop Skill. It compiles a schema v2 YAML profile with execution, evaluation, strategy, and policy contracts.

3. Materialize and approve

uv run research-loop new-campaign --repo /path/to/project --profile /tmp/research-profile.yaml --base HEAD
uv run research-loop validate --repo /path/to/project
uv run research-loop plan --repo /path/to/project

Present the complete dry run. Only after explicit user approval:

uv run research-loop approve --repo /path/to/project --plan-hash <hash>

4. Run the campaign

Use the exact baseline, hypothesis, evidence, candidate, ranking, and experiment sequence in the Skill's references/workflow.md. Run status after every recorded result and read the active campaign's handoff.md when resuming. Strategy transitions happen only after record and only when an approved rule matches.