Using Cloud 66 Toolbelt

What is Cloud 66 Toolbelt?

Cloud 66 Toolbelt makes it possible to interact with Cloud 66 from the comfort of your command line, and is available for Linux, Mac and Windows.

How to install Toolbelt

To get started, simply download the Toolbelt executable, unzip and copy it to a directory accessible in your PATH.

On Mac OS X, your PATH is likely /usr/local/bin, but you can run echo $PATH in your terminal to determine your specific path. Placing the executable in this folder allows it to be used globally.

Initialize Toolbelt

Before using Toolbelt, you need to link it to your Cloud 66 account. You can do this by issuing any of the available commands, for example:

$ cx stacks list

This will return a URL that you need to copy and paste into your browser.

Following this URL will redirect you to your account (you need to be logged in) and ask for your authorization to allow Toolbelt to view, edit, redeploy and administrate your stacks and servers.

Once authorized, you will be presented with an authorization code which needs to be pasted back into the terminal.

Advanced

The authorization information is stored in the ~/.cloud66/cx.json file. Removing this file will remove the authorization code from your client.

Deauthorising Toolbelt

To deauthorize Toolbelt, login to your Cloud 66 account and click on the Revoke access button under your Account page.

Basic Toolbelt commands

Multiple account support

By default, Toolbelt can work with all of the accounts of which you are member. If you have a Team membership on Cloud 66, your Toolbelt will automatically work with all the stacks you have access to under that team’s account without any change.

If you own more than one Cloud 66 account (and are not just a team member), then you can use the --account global option when using Toolbelt. Using the account option you can give your accounts different names and switch between them. Here is an example:

$ cx --account=personal stacks list

This will ask for Toolbelt authorization when run the first time. Once authorized, it will work as expected.

To add a new account, simply change the value of the account parameter:

$ cx --account=work stacks list

This will again ask for authorization the first time you run it. Once authorized you can switch between personal and work (or any other name you would like) by just adding the --account option.

Update the toolbelt

Toolbelt updates are released periodically to improve the functionality available through the command line, and these are normally applied automatically in the background.

Whenever a command is executed, Toolbelt will check whether or not a newer version is available and do a silent update. You can also update manually using cx update.

You can check which version you are using by running cx -v.

If you install Toolbelt in a shared folder, you may need to elevate your permissions in order to run an update. In this case, you can simply run sudo cx update.

Toolbelt shortcuts

Stack links

To make life easier for you, Toolbelt detects the Git URL and branch for each directory in which it is run. As such, you won’t have to specify which stack Toolbelt should be modifying if you’re in the git folder and branch of one of your stacks.

Naming shortcuts

We apply naming shortcuts to both stack and server names, as well as server roles in Toolbelt.

We just need you to type enough of a name for it to be unique. For example, if you only have one stack that starts with m, you can simply type m. Similarly, if you only have one web server, you can type w instead of web.

Auto-complete

Toolbelt has an optional auto-complete feature which will make typing commands out by hand much quicker.

To enable auto-complete follow these instructions.

Contributing

Toolbelt is open source, and we welcome constructive contributions. Fork our repository and create a feature branch. When your changes are ready, commit/push them and then create a pull request on GitHub.