Skip to content

Configuration

RTMX is configured via rtmx.yaml in your project root.

rtmx:
database: docs/rtm_database.csv
requirements_dir: docs/requirements
schema: core
rtmx:
# Database location
database: docs/rtm_database.csv
# Requirements specification directory
requirements_dir: docs/requirements
# Schema type: core, phoenix, or custom
schema: core
# Pytest integration
pytest:
marker_prefix: "req"
register_markers: true
strict_markers: false
# GitHub integration
github:
enabled: false
repo: owner/repo
label_prefix: "req:"
sync_on_push: false
# Jira integration
jira:
enabled: false
url: https://your-org.atlassian.net
project_key: PROJ
sync_on_push: false
# MCP server settings
mcp:
enabled: true
tools:
- status
- backlog
- get_requirement
- update_status
- deps
- search
# Validation rules
validation:
require_test_function: false
require_acceptance_criteria: false
require_owner: false
max_phase: 10
OptionTypeDefaultDescription
databasestringdocs/rtm_database.csvPath to RTM database
requirements_dirstringdocs/requirementsPath to requirement specs
schemastringcoreSchema type
OptionTypeDefaultDescription
marker_prefixstringreqPrefix for requirement markers
register_markersbooltrueAuto-register markers
strict_markersboolfalseFail on unknown markers
OptionTypeDefaultDescription
enabledboolfalseEnable GitHub sync
repostring-Repository in owner/repo format
label_prefixstringreq:Prefix for issue labels
sync_on_pushboolfalseSync on git push
OptionTypeDefaultDescription
enabledboolfalseEnable Jira sync
urlstring-Jira instance URL
project_keystring-Jira project key
sync_on_pushboolfalseSync on git push
OptionTypeDefaultDescription
enabledbooltrueEnable MCP server
toolslistallEnabled MCP tools

Override configuration with environment variables:

RTMX_DATABASE=custom/path.csv rtmx status
RTMX_GITHUB_TOKEN=ghp_xxx rtmx sync github
JIRA_API_TOKEN=xxx rtmx sync jira

Use different configs for different environments:

rtmx --config rtmx.production.yaml status
rtmx --config rtmx.staging.yaml status

Validate your configuration:

rtmx config # Show current config
rtmx config --validate # Validate config
rtmx config --init # Create default config