Skip to main content

Command-line Interface (CLI)

Overview​

The Nimbus Command Line CLI allows you to control and inspect your robot agent directly from a terminal without using the web UI. It mirrors most operations available on the Cogniteam Cloud Platform and exposes additional diagnostic and maintenance tools.

To see the built-in help menu:

nimbus -h

Each top-level manager exposes its own set of subcommands:

nimbus <group> <command> [arguments]

Connection And Access​

CLI manager commands communicate with the running Agent over gRPC. A connection through the Agent's actual loopback address can run without a password. When targeting an Agent on another computer with authentication enabled, set the existing NIMBUS_CLI_AUTH environment variable to that Agent's password. Supply the password itself; the CLI encodes its authentication header for both ordinary commands and streaming commands. Explicit NoAuthentication configuration permits password-free management access.

Shell completion uses the Agent's localhost HTTP endpoint and is restricted to the Agent computer. A remote password or bearer token does not enable remote completion. Completion remains noninteractive and does not open a browser login.

Command Groups​

CommandDescription
sessionManage active I/O sessions
platformInspect hardware, OS, and device info
kpiMonitor real-time KPI updates
notificationList notification settings and watch emitted notifications
debugManage Debug settings and support bundles
configLoad, stop, or inspect configurations
systemManage agent versions, logs, and services
compManage components (start/stop/stats/params)
deviceList registered hardware devices
streamView and manipulate data streams
rtsp-streamingManage saved on-demand RTSP video profiles
serviceCall or inspect ROS services
securitySecurity hardening and access control
taskManage persisted agent tasks and task catalog files
fleetManage local fleet robots and fleet presets
presetManage robot presets
recordRecord and upload sensor data (previously datalog)
fileInspect file status, upload files, and synchronize storage
paramManage ROS1/ROS2 dynamic parameters
ros2-listen / grepDiscover ROS 2 topics and search CLI commands
nav2Run Nav2 commands
actionsDiscover, execute and observe registered ROS2 actions