Skip to content
RTMX

Quickstart

1. Set up RTMX in your project

Section titled “1. Set up RTMX in your project”
rtmx setup

This creates everything you need:

  • rtmx.yaml — Configuration file
  • docs/rtm_database.csv — Requirements database
  • docs/requirements/ — Requirement specification files
  • Makefile targets (make rtm, make backlog)
  • AI agent configs (CLAUDE.md, .cursorrules)

For existing projects, use --branch to review changes before merging:

rtmx setup --branch    # Creates a git branch for review
rtmx setup --pr        # Creates branch + opens PR

2. Check your status

Section titled “2. Check your status”
rtmx status -v    # Verbose output with category breakdown
rtmx status -vv   # Very verbose with requirement details
rtmx status -vvv  # Maximum detail

3. See what to work on next

Section titled “3. See what to work on next”
rtmx backlog

The backlog shows requirements sorted by priority and phase, with dependency information.

4. Run health checks

Section titled “4. Run health checks”
rtmx health

Health checks verify:

  • RTM database can be loaded
  • All requirement IDs are valid
  • Dependencies reference existing requirements
  • Test files and functions exist
Section titled “5. Link tests to requirements”
import pytest


@pytest.mark.req("REQ-AUTH-001")
@pytest.mark.scope_unit
def test_oauth_login():
    """Validates REQ-AUTH-001: OAuth 2.0 authentication."""
    assert authenticate_user(token) == expected_user

Then scan your tests:

rtmx from-tests

Using the Makefile

Section titled “Using the Makefile”

After rtmx setup, you get these Makefile targets:

make rtm       # Quick status check
make backlog   # See what's next
make health    # Run health checks

Next Steps

Section titled “Next Steps”