Coder provides an open-source CLI for interacting with your deployment.

Download and Install

The version numbering for CLI releases mirrors the version numbering for Coder releases. Obtain the CLI release whose version number matches the version number of your Coder deployment. You'll find all CLI releases on GitHub.

Once you've obtained the correct release, you can proceed with the installation process.

Linux Installation

1. Download the coder-cli-linux-amd64.tar.gz file that corresponds with the Coder version you're using
2. Extract the coder binary from the .tar file. For example:

cd ~/go/bin
tar -xvf ~/Downloads/coder-cli-linux-amd64.tar.gz

macOS Installation

1. Download the coder-cli-darwin-amd64.tar.gz file that corresponds with the Coder version you're using
2. macOS should automatically extract the CLI for you. Move the coder binary to the location of your choice (e.g., Applications)
3. To open the CLI for the first time, hold the control key while clicking on the executable and following the prompts presented. This allows you to override your OS' security features

Authentication

Once you've installed the CLI, you must authenticate the CLI with your Coder deployment. To do this, run the following in the CLI: coder login

If you are already logged into Coder on your web browser, the process will proceed automatically; otherwise, you'll be asked to log in.

If the network on which you're running the command is different from the one on which your browser runs, this process won't work. See the GitHub issue for additional information.

Next, call coder login with the URL to your deployment:

$ coder login https://coder.mycompany.com
Opening in existing browser session.
2020-05-19 16:49:56 SUCCESS logged in

If this process is successful, you are now ready to use the CLI.