Command Line Interface#

Overview#

The Command Line Interface (CLI) is a text interface that has feature parity with the Desktop App.: It gets installed locally with the Desktop App and actually has more functionality. You can use it in place of or in combination with the Desktop App. You can learn all about it by opening a terminal and running nvwb --help.
The CLI is how you install AI Workbench on a remote machine.: You cannot install the Desktop App on a remote machine. Instead, you curl the CLI and run an installation command. After that you can add that remote location to your Desktop App through the Desktop App or the CLI.
The CLI doesn’t have a Location Manager, but it uses individual terminals like Desktop App location windows.: Opening a Workbench location in a terminal with the command nvwb activate <location-name> attaches it to the location. All subsequent nvwb commands in the terminal will point at the activated location until you deactivate it.
The CLI has important functionality the Desktop App does not yet.: Two examples of this are the --external-access flag and the validate subcommand. External access configures a remote location to route web traffic to containerized applications running on the remote. Validate lints a spec.yaml file to check formatting issues that may arise if you edit it.

Locations Before Projects:: You can’t work in a project through the CLI until you’ve activated the particular remote the project is on in the terminal.
One Terminal, One Location, One Project:: You can’t have two locations active in the same terminal at once. You also can’t have two projects open in the same terminal at once.
One Location, Many Terminals, Many Projects:: You can work on as many projects in a location as you like by using multiple terminals.