Quick Start

This is the 60-second path. It skips explanation. See Getting Started for more detail and Commands for the full reference.

1. Install

pip install romyq

2. Create a workspace

mkdir my-api && cd my-api
git init
romyq init

The wizard prompts for your mission, complexity profile, and DeepSeek API key. At the end you see a lifecycle preview. Confirm to proceed.

Alternatively, for an existing codebase:

cd my-existing-project
romyq attach

3. Edit your mission

romyq init creates mission.md in the project root. Edit it:

Build a REST API for task management.
Use Node.js with Hono. PostgreSQL with Drizzle ORM.
Authentication via JWT. Tests required for all endpoints.

No template or schema required — plain language is fine.

4. Check the environment

romyq doctor

Fix any issues reported before continuing.

5. Run

romyq run

Romyq generates a task plan with DeepSeek and executes each task with Claude Code. Every successful task becomes a git commit.

To stop automatically when the mission is complete:

romyq run --until-complete

6. Monitor in a second terminal

romyq status       # current task and loop state
romyq roadmap      # phase progress
romyq dashboard    # full lifecycle overview (text)
romyq ui           # live Textual TUI (requires pip install 'romyq[ui]')

7. Steer

While the loop is running:

# From any terminal
romyq steer "use Drizzle ORM, not Prisma"
romyq steer "authentication must be complete before any protected routes"
romyq rules add "Always write tests for every endpoint"
romyq pause     # pause after current task
romyq resume    # continue
romyq stop      # graceful shutdown

Or launch the operator shell alongside the loop:

romyq shell

At the > prompt, type any built-in command (status, roadmap, readiness, recommendation) or free-text instruction. Free text is recorded as a steering note.

8. Check progress

romyq readiness       # 0–100 score across Core Functionality, Testing, Security, Operations
romyq recommendation  # Continue / Pause / Review / Stop
romyq timeline        # chronological log of all events
romyq decisions       # governance decision log

What happens automatically

• Every successful task is committed to git
• Governance rules are enforced before each task executes
• The knowledge base is updated after each task
• Readiness is recomputed after each task
• A recommendation is emitted after each task

When the recommendation is Stop, all phases are complete and all done criteria are satisfied. Run romyq stop to exit the loop.