How to Use
GRID CLI
This section provides detailed information on how to use the GRID Enterprise Command-Line Interface (CLI). The GRID CLI acts as an orchestration module for the GRID containers and sessions. Run it by typing
session start
Starts a session with the specified session ID and configuration path on the chosen resource (defaults to
session stop
Stops the session with the specified ID.
open nb | sim | viz
Opens the corresponding entity for the specified session:
grid at the terminal in the appropriate Python virtual environment.
Commands Overview
Below is a list of the available commands in the GRID Enterprise CLI. Resource targeting is done using the@resource_name syntax, defaulting to @local if no resource is specified. In this document, we will assume that the GRID containers are running on the same machine as the CLI, which is the most straightforward setup.
The first step is to log into the GRID platform and initialize the containers. Open your terminal and run the following command:
Show Expected Output
Show Expected Output
login
Logs into the GRID container registry using the username and password from the resouece configuration.Show Expected Output
Show Expected Output
init
Spins up the GRID containers on the specified node (defaults tolocal if no node is specified). Upon running this command, GRID will ask you for your choice of simulator. Currently supported options are AirGen and Isaac Sim.
Show Expected Output
Show Expected Output
terminate
Terminates the GRID containers on the specified node.Show Expected Output
Show Expected Output
update
Updates the GRID containers on the specified node. You must be authenticated to the container registry for this to work. If no simulator choice was already provided, this command will ask you for your preferred simulator choice.Show Expected Output
Show Expected Output
session start <session_id> <config_path> @<resource_name>
Starts a session with the specified session ID and configuration path on the chosen resource (defaults to @local if no resource is specified). If no configuration file path is provided, GRID will use a sample configuration. Please ensure that you have initialized the GRID containers (for your preferred simulator) before starting a session.
Show Expected Output
Show Expected Output
session stop <session_id>
Stops the session with the specified ID.
Show Expected Output
Show Expected Output
session list
Lists all ongoing sessions.Show Expected Output
Show Expected Output
open nb | sim | viz @<node_name>
Opens the corresponding entity for the specified session:
- nb: Jupyter notebook
- sim: Simulation stream
- viz: Rerun visualization
Show Expected Output
Show Expected Output
help
Displays a list of all available commands and their functions.Show Expected Output
Show Expected Output