CLI Reference

Core Commands

Command	Description
rtmx setup	Complete RTMX setup (config, RTM, agents, Makefile)
rtmx init	Minimal setup (config and RTM database only)
rtmx status	Show completion progress (-v, -vv, -vvv for detail)
rtmx backlog	Show prioritized incomplete requirements
rtmx health	Run integration health checks
rtmx config	Show or validate configuration

Dashboard Commands

Command	Description
rtmx serve	Start web dashboard with REST API
rtmx tui	Launch interactive terminal dashboard

Analysis Commands

Command	Description
rtmx deps	Show dependency graph
rtmx cycles	Detect circular dependencies
rtmx reconcile	Check/fix dependency reciprocity
rtmx analyze	Discover requirements from project artifacts
rtmx diff	Compare RTM versions (for PRs)

Integration Commands

Command	Description
rtmx from-tests	Scan tests for requirement markers
rtmx bootstrap	Generate RTM from tests, GitHub, or Jira
rtmx sync	Synchronize with GitHub Issues or Jira
rtmx install	Install prompts into AI agent configs
rtmx makefile	Generate Makefile targets
rtmx mcp-server	Start MCP server for AI agent integration
rtmx docs	Generate schema and config documentation

Command Details

rtmx setup

Complete project setup with all RTMX features:

rtmx setup              # Interactive setup
rtmx setup --branch     # Create git branch for review
rtmx setup --pr         # Create branch and open PR

Creates:

• rtmx.yaml configuration
• docs/rtm_database.csv requirements database
• docs/requirements/ specification directory
• Makefile targets
• AI agent configs (CLAUDE.md, .cursorrules)

rtmx status

Show project progress:

rtmx status         # Summary only
rtmx status -v      # Category breakdown
rtmx status -vv     # Requirement details
rtmx status -vvv    # Maximum detail

rtmx backlog

Show prioritized incomplete requirements:

rtmx backlog              # All incomplete
rtmx backlog --phase 1    # Filter by phase
rtmx backlog --blocked    # Show only blocked items

rtmx health

Run integration health checks:

rtmx health              # Standard output
rtmx health --format ci  # CI-friendly output
rtmx health --fix        # Auto-fix issues where possible

rtmx deps

Analyze dependency relationships:

rtmx deps REQ-AUTH-001              # Show dependencies for a requirement
rtmx deps --all                     # Show full dependency graph
rtmx deps --critical-path           # Show critical path

rtmx sync

Synchronize with external services:

rtmx sync github          # Sync to GitHub Issues
rtmx sync jira            # Sync to Jira
rtmx sync --dry-run       # Preview changes without applying

rtmx serve

Start web dashboard with REST API:

rtmx serve                         # Start on localhost:8080
rtmx serve --host 0.0.0.0          # Bind to all interfaces
rtmx serve --port 3000             # Custom port
rtmx serve --reload                # Auto-reload on changes

rtmx tui

Launch interactive terminal dashboard:

rtmx tui                           # Start interactive TUI

Requires rtmx[tui] extra: pip install rtmx[tui]

rtmx mcp-server

Start MCP server for AI agent integration (stdio transport):

rtmx mcp-server                    # Start on stdio (for MCP clients)
rtmx mcp-server --daemon           # Run as background daemon
rtmx mcp-server --pidfile mcp.pid  # Specify PID file for daemon

The MCP server uses JSON-RPC over stdin/stdout. Configure your MCP client (e.g., Claude Desktop) to launch it:

{
  "mcpServers": {
    "rtmx": {
      "command": "rtmx",
      "args": ["mcp-server"]
    }
  }
}

rtmx docs

Generate documentation:

rtmx docs schema                   # Show schema documentation
rtmx docs config                   # Show configuration documentation

Global Options

Option	Description
--config PATH	Use specific config file
--database PATH	Use specific RTM database
--verbose, -v	Increase verbosity
--quiet, -q	Decrease verbosity
--help, -h	Show help message
--version	Show version