Is this page helpful?

Command Line Interface#

Overview#

The CLI is a terminal based interface for managing AI Workbench locations and projects.

It has feature parity with the Desktop App and can run interactively with the command nvwb. You can use it in place of, or along with, the Desktop App.

It’s available on Ubuntu and macOS when you install the Desktop App.

However on Windows it requires the full local install to be available.

The interactive CLI has the same navigation levels as the Desktop App.

Run nvwb activate <location-name> to attach a terminal to a location Further nvwb commands will target that location until you deactivate it.

Then run nvwb open <project-name> to attach the terminal to a project in that location. Further nvwb commands will target that project until you close it.

The CLI is scriptable for programmatic use by agents.

Agents can use the CLI binary by calling ~/.nvwb/bin/nvwb-cli. It has human readable and json outputs along with some (but not complete) support piping.

Key Concepts#

Locations Before Projects:

You can’t work in a project through the CLI until you’ve activated the particular remote the project is on.

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.