CLI Reference

Primary command surface for developers

The CLI is the main surface for developer workflows. The default path is the managed debug-session workflow; connect remains available as the expert low-level tunnel command.

Auth and discovery

robotunnel init "<platform-token>"
robotunnel list

Use these first to authenticate the developer machine and confirm the target robot is online.

Managed debug sessions

robotunnel debug start <robot> --mode foxglove
robotunnel debug open <robot> --launch
robotunnel debug status <robot>
robotunnel debug profiles <robot>
robotunnel debug stream <robot> --session-id <sid> --topic /scan --follow
  • debug start creates the session and applies profile / policy.
  • debug open attaches locally and opens the endpoint when requested.
  • debug status and debug profiles help inspect the session.
  • This is the default CLI-first developer path; use it before reaching for raw transport control.

Expert low-level connect path

robotunnel connect <robot> --transport-policy auto

Use this when you want route-level control or a plain tunnel-oriented workflow. It is supported, but it is not the default onboarding path.

Direct skill invocation

robotunnel skill <robot> host_debug status
robotunnel skill <robot> ros2_observe topics
robotunnel skill <robot> visual_debug status --params '{"session_id":"..."}'

Use skill calls for deterministic robot-side actions from scripts, a second terminal, or higher-level workflows. See the dedicated Skills guide for when to use visual_debug, ros2_observe, host_debug, and monitor.