Command Line Interface#


Screenshot of the command line interface help menu.

Overview of the Command Line Interface#

What is it?#

  • The command line interface (CLI) is a tool that allows you to manage your AI Workbench projects from the command line

  • It’s installed locally as part of the Desktop App

  • It has feature parity with the Desktop App, and in fact has a few features that are not in the Desktop App

  • It is scriptable and can be used to automate Workbench related tasks

How to use it?#

  • List your available locations by running nvwb list contexts

  • Activate a location in the CLI by running nvwb activate <location-name>

  • List projects in the active location by running nvwb list projects

  • Open a project in the CLI by running nvwb open <project-name>

  • See the apps in a project by running nvwb list apps

  • See the status of a project by running nvwb status

Note

You can always open a terminal and run nvwb -h to see the help menu.

You can see the help for a specific command by running nvwb <command> -h, and this feature is nested so you can see the help for a subcommand by running nvwb <command> <subcommand> -h.

Learn more about the CLI here.