Installing the CLI

Installing the DC/OS command line interface

These instructions will show you how to install the core DC/OS CLI commands on your cluster. For instructions on installing DC/OS Enterprise CLI commands, see the DC/OS Enterprise CLI section.

The recommended method to install the DC/OS CLI is by getting the preformatted set of commands from the DC/OS GUI and running them in the terminal. See the prerequisites and instructions for your operating system for more information:

Installing on Linux

Prerequisites

  • You must have a separate computer that is not part of the DC/OS cluster on which you can install the CLI.
  • You must have network access from the external system hosting the CLI to the DC/OS cluster.
  • You must be able to open a command-line shell terminal on the external system hosting the CLI.
  • You must be able to run cURL program on the system hosting the CLI. The curl command is installed by default on most Linux distributions.
  • You must not be using the noexec to mount the /tmp directory unless you have set a TMPDIR environment variable to something other than the /tmp directory. Mounting the /tmp directory with the noexec option can prevent CLI operations.
  • If you are using Fedora 30 or above, you must install the libcrypt library. You can install the library by running sudo dnf install libxcrypt-compat.

Installing the CLI on Linux from the GUI

  1. At the top-right corner of the DC/OS GUI, click the down arrow to the right of your cluster name.

    open cluster popup

    Figure 1. Open cluster popup menu

  2. Select Install CLI.

    CLI install UI

    Figure 2. Select Install CLI

  3. Copy and paste the code snippets appropriate to your OS into your terminal, and press the return key.

    CLI copy/paste

    Figure 3. Code snippet window

  4. Once the DC/OS information screen has been displayed, run the command dcos cluster list to verify the connection to the cluster has been established.

Installing the DC/OS CLI manually

It is strongly recommended that you copy and paste the installation commands from the GUI of the cluster to which you want to connect. Following are the instructions for step by step installation of the CLI.

  1. If you do not already have a working directory for the CLI, create one. The preferred location is /usr/local/bin and all the instructions will reference this path.

    [ -d usr/local/bin ] || sudo mkdir -p /usr/local/bin

  2. Download the DC/OS CLI binary to your local directory by running the following command and replacing <target-os-type> with the OS type (darwin, linux, windows), and <dcos-version> with the version (such as 1.12), that you want to use.

    curl https://downloads.dcos.io/binaries/cli/<target-os-type>/x86-64/dcos-<dcos-version>/dcos -o dcos

    For example, the CLI download for a Linux user on DC/OS 1.12 would look like this:

    curl https://downloads.dcos.io/binaries/cli/linux/x86-64/dcos-1.12/dcos -o dcos

  3. Move the CLI binary to your local bin directory.

    sudo mv dcos /usr/local/bin

  4. Make the CLI binary executable.

    chmod +x /usr/local/bin/dcos

  5. Set up the connection from the CLI to your DC/OS cluster. In this example, http://example.com is the master node URL.

    dcos cluster setup http://example.com

    Follow the instructions in the DC/OS CLI. For more information about security, see Security.

    Your CLI should now be authenticated with your cluster! Enter dcos to get started. You can learn more about managing your cluster connections here.

Installing on macOS

Prerequisites

  • You must have a separate computer that is not part of the DC/OS cluster on which you can install the CLI.
    • MacOS X Yosemite (10.10), or later.
    • A model running on a Haswell CPU (2014), or later.
  • You must have network access from the external system hosting the CLI to the DC/OS cluster.
  • You must be able to open a command-line environment, such as Terminal, on the external system hosting the CLI.
  • You must be able to run cURL program on the system hosting the CLI. If you don’t have cURL, follow the instructions in Install curl on Mac OSX to install it.
  • You must not be using noexec to mount the /tmp directory unless you have set a TMPDIR environment variable to something other than the /tmp directory. Mounting the /tmp directory with the noexec option can prevent CLI operations.

Installing the CLI on macOS from the GUI

  1. At the top-right corner of the DC/OS GUI, click the down arrow to the right of your cluster name.

    open cluster popup

    Figure 1. Open cluster popup menu

  2. Select Install CLI.

    CLI install GUI

    Figure 2. Select Install CLI

  3. Copy and paste the code snippets appropriate to your OS into your terminal.

    CLI copy/paste

    Figure 3. Code snippet window

  4. Once the dcos information screen has been displayed, run the command dcos cluster list to verify the connection to the cluster has been established.

Installing the CLI on macOS manually

  1. Download the DC/OS CLI binary dcos to your working directory by running the following command and replacing <target-os-type> with the OS type (darwin, linux, windows), and <dcos-version> with the version (such as 1.12), that you want to use:

    curl https://downloads.dcos.io/binaries/cli/<target-os-type>/x86-64/dcos-<dcos-version>/dcos -o dcos

    For example, the CLI download for a Mac user on DC/OS 1.12 would look like this:

    curl https://downloads.dcos.io/binaries/cli/darwin/x86-64/dcos-1.12/dcos -o dcos

  2. Make the CLI binary executable.

    chmod +x dcos

  3. Set up the connection from the CLI to your DC/OS cluster. In this example, http://example.com is the master node URL.

    dcos cluster setup http://example.com

    If your system is unable to find the executable, you may need to re-open the command prompt or add the installation directory to your PATH environment variable manually.

    Follow the instructions in the DC/OS CLI. For more information about security, see the documentation.

    Your CLI should now be authenticated with your cluster!

  4. Type dcos to view usage information and get started.

Installing on Windows

Prerequisites

  • You must have a separate computer that is not part of the DC/OS cluster on which you can install the CLI.
    • Windows 10 64-bit or later.
  • You must have network access from the external system hosting the CLI to the DC/OS cluster.
  • You must be able to open a command-line environment, such as Windows PowerShell or the cmd.exe program, on the external system hosting the CLI. Windows PowerShell is installed by default on Windows 7, and later.
  • You nust disable any security or antivirus software before you start the installation.
  • You must not be using the noexec to mount the /tmp directory unless you have set a TMPDIR environment variable to something other than the /tmp directory. Mounting the /tmp directory with the noexec option can prevent CLI operations.

Installing the CLI on Windows from the GUI

  1. At the top-right corner of the DC/OS GUI, click the down arrow to the right of your cluster name.

    open cluster popup

    Figure 1. Open cluster popup menu

  2. Select Install CLI.

    CLI install UI

    Figure 2. Select Install CLI

  3. Follow the commands listed in the dialog.

    CLI copy/paste

    Figure 3. Code snippet window

  4. Once the dcos information screen has been displayed, run the command dcos cluster list to verify the connection to the cluster has been established.

Installing the CLI on Windows manually

  1. Open the command line environment using the Administrator credentials.

  2. Download the DC/OS CLI binary dcos to your working directory by running the following command and replacing <target-os-type> with the OS type (darwin, linux, windows), and <dcos-version> with the version (such as 1.12), that you want to use:

    curl https://downloads.dcos.io/binaries/cli/<target-os-type>/x86-64/dcos-<dcos-version>/dcos -o dcos

    For example, the CLI download for a Windows user on DC/OS 1.12 would look like this:

    curl https://downloads.dcos.io/binaries/cli/windows/x86-64/dcos-1.12/dcos -o dcos

  3. Change into the directory of the downloaded file if you are not already there.

    cd path/to/download/directory

  4. Set up the connection from the CLI to your DC/OS cluster. In this example, http://example.com is the master node URL.

    dcos cluster setup http://example.com

    NOTE: If your system is unable to find the executable, you may need to re-open the command prompt or add the installation directory to your PATH environment variable manually.

    Follow the instructions in the DC/OS CLI. For more information about security, see the documentation.

    Your CLI should now be authenticated with your cluster! Enter dcos to get started.