Getting Started

A quick start guide for the installation and authentication for the CLI.


$ pip install spb-cli
$ spb --version

Once you install the CLI using the above command, you can type spb command in the terminal to access our Command-line Interface.


You need an Access Key to authenticate yourself and start using the CLI. The Access Key can be generated on the Suite Website under My Account > Advanced menu.

You can then configure your CLI by entering your Suite Account Name and the generated Access Key to your terminal.

The Account Name refers to the organization name that you belong to. It does not mean the email address you use to sign in.

This is the account name.

$ spb configure
Suite Account Name: foo
Access Key: bar

Once configured, you can check the currently configured profile by using the --list option.

$ spb configure --list
access_key = foo
account_name = bar

Any other questions? E-mail us at [email protected].