Getting Started

What you'll need

• Python 3.10 or later
• Git
• A DeepSeek API key — for planning
• Claude Code installed and authenticated — for execution

Install

pip install romyq
romyq version   # confirm: romyq 0.10.3

New project

mkdir my-project
cd my-project
git init
romyq init

The wizard asks for your mission, complexity profile, and DeepSeek API key. It writes .env, creates .romyq/, generates a mission.md, and shows a lifecycle preview from DeepSeek before you confirm.

Existing project

cd my-existing-project
romyq attach

This attaches Romyq without running the wizard. It creates .romyq/ and a mission.md template. Edit mission.md to describe what you want built.

Set your API key

If you need to set or update the key manually:

echo "DEEPSEEK_API_KEY=sk-..." >> .env

Check your environment

romyq doctor

This validates your API key, Claude Code installation, and git setup. Fix any reported issues before running.

Run

romyq run

Romyq reads mission.md, generates a task plan with DeepSeek, and executes each task with Claude Code. Every successful task is committed to git. The loop runs until you stop it or add --until-complete.

romyq run --until-complete   # stop automatically when done
romyq run --approval         # approve each task before it executes

Monitor

Open a second terminal while romyq run is active:

romyq status       # current task and loop state
romyq dashboard    # full lifecycle text overview
romyq health       # high-level health summary

Or launch the live Textual TUI (requires pip install 'romyq[ui]'):

romyq ui

Steer and control

romyq pause                              # pause after current task
romyq resume                             # resume
romyq stop                               # graceful shutdown
romyq steer "use PostgreSQL"             # inject instruction into next planning call
romyq note "focus on auth next"          # add a steering note
romyq rules add "Always write tests"     # add a governance rule

Next steps

• Quick Start — complete end-to-end walkthrough
• Commands — full CLI reference (40 commands)
• Complexity Profiles — Basic, Intermediate, Advanced
• Governance — rules and the decision log