Generated from rr --help

RouteRTL command map

A single CLI for the full FPGA workflow.

Explore the public top-level rr command guide—from first project through verification, build, deployment, and evidence. RouteRTL drives four vendor ecosystems without requiring their desktop GUIs.

81: documented commands
10: functional groups
4: vendor ecosystems
1: declarative project model

This guide covers the public top-level workflow. Run rr help <command> for nested commands and options. Embedded Linux flows also consume declarative rootfs and platform inputs.

Live inventory

Command list guide

Descriptions come directly from the installed CLI help. Select a command to unroll its subcommands, or open its section in the SDK guide.

Start & Health

Install, initialize, inspect, and maintain the SDK.

Hardware Build

Take RTL from project discovery through a programmed device.

Lint & Rules

Apply design checks and reusable lint policies.

rr lintinglinting(top, clean, src, exclude_files, profile_name, findings_path, fail_on_severity, forest, as_json)

Verification

Discover, run, and diagnose simulation and formal workflows.

IP & Registers

Manage reusable IP, register banks, ROMs, and project sources.

Provenance & Reporting

Audit contracts, artifacts, releases, and engineering evidence.

Governance

Coordinate shared resources and repeatable automated work.

Workspace & Migration

Configure projects, workspaces, CI, and vendor migrations.

rr schemaschema_command(query: tuple, section: str | None, field: str | None, scope: str | None, as_json: bool)

Linux · Docker · EDA

Prepare embedded Linux and reproducible tool environments.

rr envenv_command(tool: str | None, all_tools: bool, refresh: bool, list_only: bool, version_pin: str | None) -> None

AI Assistant

Connect agents to RouteRTL knowledge and workflow context.

rr askask_command(question: tuple, search_only: bool, mode: str, top_k: int)

Configuration layers

Operational commands extend the project model

project.yml stays portable. Schedules, physical-bench wiring, coordination state, and workspace evidence live at the scope where they belong.

ScopeConfiguration or stateCommandsWhat it controls

Portable projectproject.ymlrr queue · rr lease · rr automation

Selects the active target and board. It can also opt builds and simulations into the queue, or hold a small automation block.

Scheduled workautomation.ymlrr automation

Defines recurring commands and the host scheduler that runs them. When present, it takes the place of the project.yml automation block.

Physical bench~/.config/routertl/bench.ymlrr lease

Maps targets to host-specific resources such as boards, UARTs, JTAG cables, TFTP paths, and bench addresses. runtimes/hw.yml remains a project-local fallback.

Host-local stateLocal SQLite storesrr queue · rr lease · rr telemetry

Keeps jobs, hardware ownership, and command telemetry local to the machine. These databases are coordination state, not portable project inputs.

Workspace evidence.routertl_cache/rr loop · rr metrics

Records loop sessions and build measurements beside the workspace so evidence follows the work without becoming project configuration.

Host configuration follows the XDG configuration and state directories when they are set; the paths above show the usual defaults.

Explore every project.yml configuration area

Toolchain support

Supported FPGA toolchains

RouteRTL reads the project configuration, resolves sources and constraints, then invokes the matching vendor flow.

AMD / Xilinx
Intel
Lattice
Microchip