Skip to main content
The GRID CLI is an interactive shell that orchestrates GRID containers and sessions. Launch it by typing grid inside your Python environment. 
grid

 .d8888b.  8888888b.  8888888 8888888b.
d88P  Y88b 888   Y88b   888   888  "Y88b
888    888 888    888   888   888    888
888        888   d88P   888   888    888
888  88888 8888888P"    888   888    888
888    888 888 T88b     888   888    888
Y88b  d88P 888  T88b    888   888  .d88P
 "Y8888P88 888   T88b 8888888 8888888P"

General Robot Intelligence Development Platform - Enterprise version
General Robotics Technology, Inc.

Type help for list of commands.

GRID #
Commands target the default node unless you specify one with @nodename (e.g., init airgen @lab-gpu-0). Use node list and node select to manage nodes.

​
Quick Reference

CommandDescription
loginAuthenticate with the container registry
init [sim]Start GRID containers
terminateStop GRID containers
update [sim]Pull latest containers and refresh assets
update assetsForce redownload simulator assets
update samplesUpdate sample notebooks
session start <id> [config]Start a simulation session
session stop [id]Stop a session
session listList active sessions
open nb|sim|viz|code|uiOpen interfaces in browser/IDE
logs <source> [N]View logs
node list|selectManage target nodes
help [cmd] [subcmd]Show help

​
Node Management

node list

Display all configured nodes and their IP addresses.

node select

Set the default target node for subsequent commands.
node list
node select lab-gpu-0

+----------+-------------+
| Node Name| IP Address  |
+==========+=============+
| local    | 127.0.0.1   |
| lab-gpu-0| 10.40.0.10  |
+----------+-------------+
Default node set to lab-gpu-0
Need to add or edit nodes? See Remote Nodes & Client Mode.

​
Authentication

​
login

Authenticates with the GRID container registry using credentials from your license.json. Required before pulling container images. 
login @local

Logging in to General Robotics – GRID registry...
Login successful!

​
Container Lifecycle

​
init

Spins up GRID containers on the target node. Supported simulators: airgen, isaac, isaac5. 
init airgen @local
init isaac --verbose @local

Initializing assets …
Assets initialized.
Starting airgen on local …
Checking container statuses...
grid_core: ✓
grid_server: ✓
grid_sim_airgen: ✓
Containers are active.

​
terminate

Stops all GRID containers on the target node. 
terminate @local
terminate --verbose @local

Checking container statuses...
grid_core: ✗
grid_server: ✗
grid_sim_airgen: ✗
Containers stopped successfully.

​
Updates

update

Pull latest container images and refresh assets.

update assets

Force redownload simulator environment assets.

update samples

Update sample notebooks from the repository.

​
update

Pulls the latest container images and refreshes shared assets. 
update airgen @local
update isaac --verbose @local

Checking for updates …
✔ sim-airgen Pulled
✔ core Pulled
✔ server Pulled
Updating assets …
Assets initialized.

​
update assets

Force redownloads simulator assets for the active sim. Useful when assets are corrupted or you need the latest environment files. 
update assets @local

Updating assets for airgen (force redownload) …
Sim assets updated.

​
update samples

Updates the sample notebooks repository while preserving local changes like Jupyter checkpoints. 
update samples @local

Updating sample notebooks …
Sample notebooks updated.

​
Session Management

​
session start

Starts a session with the specified ID. If no config is provided, a sample configuration is generated automatically. 
session start demo
session start demo ~/my_config.json @local

Using sample config at /home/grid/.grid/sample_session_airgen.json
Starting session demo on node local …
Status: Initializing session...
Status: Session has been started successfully
Session started successfully.

​
session stop

Stops a running session. 
session stop demo
session stop @local

Stopping session demo on node local …
Session stopped.

​
session list

Lists all active sessions across nodes. 
session list

+----------+--------+-------------------------------+
| Session  | Node   | Last active                   |
+==========+========+===============================+
| demo     | local  | 2025-02-11T23:24:32.991267+00 |
+----------+--------+-------------------------------+

​
Interfaces

​
open

Opens the corresponding interface for your active session.
InterfaceDescription
nbJupyter notebook
simSimulation stream
vizRerun visualization
uiWeb UI
codeVS Code attached to grid_core container
open nb @local
open sim @local
open viz @local
open code @local

If you are running the setup in your machine - http://127.0.0.1:8890
If you are running this setup from a VM - http://<vm_ip>:8890
The open code command attaches VS Code directly to the grid_core container. Requires VS Code with the Dev Containers extension. See VS Code with GRID Containers for details.

​
Logs & Diagnostics

​
logs

Shows the last N lines (default: 100) from the specified log source.
SourceDescription
commanderCommander server logs
sessionSession manager logs
replCLI/REPL logs
coregrid_core container logs
servergrid_server container logs
simSimulator container logs
logs commander 50
logs core 100
logs sim

--- Last 50 lines from commander log (/home/grid/.grid/grid_commander.log) ---
2025-02-11 20:40:13 | INFO | grid.commander | Simulation profile set to airgen
2025-02-11 20:40:14 | INFO | grid.commander | Attempting ACR login...

​
Getting Help

The help command supports both commands and subcommands: 
help                    # List all commands
help update             # Help for update command
help session start      # Help for session start subcommand
help open nb            # Help for specific interface

GRID # help session start
Start a new simulation session.

   Usage: session start <id> [config] [@nodename]

   Arguments:
     <id>       — Unique session identifier
     [config]   — Path to session config file (optional)
     [@node]    — Target node (default: local)