Install/Configure CLI #

Install #

Install the pre-compiled binary based on your system.

Homebrew (Mac) #

brew tap nullstone-io/nullstone https://github.com/nullstone-io/nullstone.git
brew install nullstone

As we release updates, you only need to run the following command to upgrade the CLI.

brew upgrade nullstone

Scoop (Windows) #

scoop bucket add nullstone https://github.com/nullstone-io/nullstone.git
scoop install nullstone

As we release updates, you only need to run the following command to upgrade the CLI.

scoop update nullstone

Go Install (Any Platform) #

go get gopkg.in/nullstone-io/nullstone.v0/nullstone

Configure CLI #

To configure your CLI, you must configure your CLI with an API Key created in Nullstone.

Visit https://app.nullstone.io/profile and click "New API Key". Typically, the name of the API Key refers to the machine/system where the API Key is stored and used.

Run the following command to configure your CLI with the generated API Key.

nullstone configure --api-key=<api-key>

Set Organization #

Run the following command to configure your CLI with an organization in Nullstone. This is required for most CLI commands to work properly.

nullstone set-org <org-name>

Alternatively, you can use the global --org flag to specify an organization per command.

nullstone --org=<org-name> deploy <app-name> <env-name>