Desktop App CLI
How to use the Desktop App's built-in command line interface (CLI)
- Updated on May 16, 2022
Banyan’s Desktop App CLI functionality will be deprecated in v.3.0.0 of the app.
Banyan CLI allows end users to run in-terminal commands to connect to Banyan services without interacting with the Banyan Desktop App. Also, using the Banyan CLI is helpful when automating common tasks, such as starting or stopping multiple services with a single command.
Install Banyan CLI
To install Banyan CLI add the following directory to your system’s
- macOS -
- Windows -
- Linux -
To verify your installation, type
bnn help and make sure the binary is executed.
Help text for the Banyan CLI
Additionally, you can set up autocomplete by running the following command and following the terminal-specific instructions:
bnn completion --help
`bnn completion --help` setup instructions
Using Banyan CLI
The table below lists all actions and commands available with Banyan CLI.
||Generates a script to configure autocompletion.|
||Displays help and available flags for a command.|
||Displays a summary of the available services.|
||Authorizes your Banyan App to connect to additional services.|
||Invalidates your session for a given organization.|
||Verifies your connection with the Banyan App.|
||Connects the service with the given name.|
||Disconnects the service with the given name.|
Keep in mind the following helpful tips when using Banyan CLI:
- Start any command with
pingto make sure you have a valid connection. For example,
bnn ping && bnn list.
- Run the command
--helpto display more information about and/or available flags for a command.
Help text (flags and instructions) for the `bnn connect` command