Skip to main content

Documentation Index

Fetch the complete documentation index at: https://bedrockdynamics.studio/docs/llms.txt

Use this file to discover all available pages before exploring further.

The roz CLI is the primary interface for interacting with robots, managing simulations, and running agent sessions. Install it with cargo install roz-cli or build from source.

​
Interactive Mode

roz
Launches the interactive TUI (terminal user interface). This is the default when no subcommand is given. The TUI provides a chat-style interface where you type natural language instructions and the agent executes them against the connected robot. The agent handles tool calls, WASM controller deployment, and safety monitoring within the TUI session. Press Ctrl+C to stop the current action, or Ctrl+D to exit.

​
Simulation Management

roz sim start [ROBOT]    # Start a sim container (e.g. ur5, px4, nav2)
roz sim stop [ROBOT]     # Stop a running sim container
roz sim status           # Show status of all sim containers
roz sim start pulls the appropriate Docker image from bedrockdynamics/substrate-sim and starts a Gazebo simulation with the robot’s full middleware stack. The container exposes an MCP server on port 8090 that the agent discovers automatically. 
# Start a UR5 manipulator simulation
roz sim start ur5

# Check what's running
roz sim status
# ROBOT    STATUS    CONTAINER ID    PORTS
# ur5      running   a1b2c3d4e5f6    8090, 11345

# Stop it
roz sim stop ur5

​
Authentication

roz auth login     # Authenticate with the roz API
roz auth status    # Show current authentication state
Authentication stores credentials locally. For self-hosted deployments, configure the API URL with ROZ_API_URL before logging in.

​
Doctor

roz doctor
Verifies that all prerequisites are installed and configured correctly. Checks for:
  • Docker daemon running
  • Required Docker images available
  • Rust toolchain version
  • Network connectivity to configured API endpoint
  • GPU availability (for Gazebo rendering)

​
Setup

roz setup
First-time configuration wizard. Walks through:
  1. LLM provider selection and API key configuration
  2. Docker verification
  3. Default robot type selection
  4. API endpoint configuration (for cloud deployments)

​
Configuration

roz config            # Show current configuration
roz config set KEY VALUE
roz config get KEY
View and edit the local roz.toml configuration file. See Configuration for the full list of options.

​
Skill Management

roz skill list         # List available skills
roz skill run NAME     # Run a named skill
Skills are reusable agent behaviors that can be triggered by name. They are defined in the project’s skill directory and can include multi-step workflows, custom tool sequences, or templated prompts.

​
Non-Interactive Mode

roz run "move the arm to the home position"
Executes a single prompt without entering the TUI. Useful for scripting and CI pipelines. The agent runs to completion and exits.

​
Other Commands

CommandDescription
roz recording listList recorded sessions
roz recording play IDReplay a recorded session
roz streamStream raw sensor/state data from the robot
roz task createCreate a task for edge worker execution
roz task status IDCheck task execution status
roz trigger listList configured triggers
roz trigger createCreate an event-driven trigger
roz host listList registered edge hosts
roz envShow environment variable configuration
roz trustManage trusted tool permissions

​
Global Flags

FlagDescription
--model MODELOverride the default LLM model
--robot ROBOTOverride the default robot type
--verboseEnable debug logging
--api-url URLOverride the API endpoint

​
Source Code

CLI implementation: crates/roz-cli/src/commands/