We recommend our Divio App for working with your projects from your own computer. It includes the tools required to do the things you need to do, and configures them appropriately. It even runs many of them from within a Docker container of its own, isolating them from other configuration of your system.

However, we know that some developers like to have more direct access and control over the tools they use. Since the Divio App uses standard tools under the hood, you can use those directly if you wish.

Please note however that although we make them available, our official support is based on use of the Divio App,and we can't always answer support questions otherwise - though we'll try if we can!

The Divio CLI

The Divio Command-line Interface is an open source tool, written in Python, and available from PyPI as well as its GitHub repository. We welcome bug-reports, pull requests and comments.

Installation

To get started, run:

pip install divio-cli

If you have an older version already installed, use:

pip install --upgrade divio-cli

It is strongly advised to keep the client up-to-date by running pip install --upgrade divio-cli regularly.

The client is released as open-source software, on GitHub. You can install the client directly from the GitHub repository with:

pip install -e git+git://github.com/divio/divio-cli.git#egg=divio_cli

Docker

Windows and Macintosh users

Install Docker for Mac or Docker for Windows as appropriate.

Linux users

Install Docker Engine installation steps, and then follow (important!) Docker's post-installation steps.

Install Docker Compose.

Git

Git is used to push and pull changes to and from the Divio Cloud. It’s used behind the scenes by the divio command and the Divio App, and you can also invoke it manually for some operations.

You'll find that your Divio Cloud projects are versioned in Git, and you can treat them like any Git repository.

Public key

In order for the Divio Cloud and your local machine to communicate securely, Divio Cloud needs to know your public key to verify your identity.

The Divio App takes care of this for you, but you can if you wish manage your keys manually.

Use the Divio Control Panel to check whether you have uploaded your public key to Divio Cloud. Any keys already uploaded to Divio Cloud will be listed there.

If you haven’t already done so, you’ll need to copy your SSH public key from your computer and add it to the Divio Cloud Panel. You’ll only need to do this once.

If you need help with setting up, finding or using your SSH keys, use our guide to setting up SSH keys before returning to this section.

Having copied your public key to your clipboard, open the SSH keys section of the Control Panel and paste your key into the Public key field. Add a name to the Title field to remind you which computer this key belongs to.

Your Divio Cloud account will now recognise your computer as a trusted host, and you’ll be protected by encrypted communication for command-line operations between the two.

Check your set-up

The Divio CLI includes a helper command to check the status of your installation's components.

Run the command divio doctor. You should see a report confirming that the various components are in order:

$ divio doctor
Verifying your system setup
✓  Login
✓  Git
✓  Docker Client
✓  Docker Machine
✓  Docker Compose
✓  Docker Engine Connectivity
✓  Docker Engine Internet Connectivity
✓  Docker Engine DNS Connectivity

Did this answer your question?