The DC/OS™ command line interface (DC/OS CLI) utility allows you to manage cluster nodes, install and manage packages, inspect the cluster state, and manage services and tasks.
DC/OS 2.0 requires the DC/OS CLI >= 0.8. To install it, follow these instructions.
To list available commands, run
dcos with no parameters:
dcos Usage: dcos [command] Commands: auth Authenticate to DC/OS cluster cluster Manage your DC/OS clusters config Manage the DC/OS configuration file diagnostics Create and manage DC/OS diagnostics bundles help Help about any command job Deploy and manage jobs in DC/OS marathon Deploy and manage applications to DC/OS node View DC/OS node information package Install and manage DC/OS software packages plugin Manage CLI plugins quota Manage DC/OS quotas service Manage DC/OS services task Manage DC/OS tasks Options: --version Print version information -v, -vv Output verbosity (verbose or very verbose) -h, --help Show usage help Use "dcos [command] --help" for more information about a command.
Setting up a cluster
In order to interact with your cluster, you first need to set up the CLI.
dcos cluster setup <cluster-url>
After following the login procedure, your CLI is now ready to interact with your cluster. You will notice that it now has additional commands such as
package and so on. These commands come from the plugins, dcos-core-cli and, if applicable, dcos-enterprise-cli, which is automatically installed as part of the setup command.
To display the DC/OS CLI version, run:
Listing your clusters
The DC/OS CLI can work with multiple clusters. The following command displays the latest configured cluster:
dcos cluster list NAME ID STATUS VERSION URL * cluster 26f72c2f-8d03-47d7-b95f-972b1fd3dea2 AVAILABLE 1.13 <cluster-url>
DC/OS CLI versions and configuration files
The DC/OS CLI has a configuration file for each connected cluster, which by default is stored in
~/.dcos/clusters/<cluster_id>/dcos.toml. You can optionally change the base portion (
~/.dcos) of the configuration directory using the
DCOS_DIR environment variable.
Installing the CLI
Installing the DC/OS command line interface…Read More
Configuring the CLI
Configuring the command line interface…Read More
Uninstalling the CLI
Uninstalling the DC/OS command line interface…Read More
How to extend the command line interface…Read More
DC/OS Enterprise CLI
Configuring the DC/OS Enterprise command line interface…Read More
Enabling autocompletion for the CLI…Read More
Exploring the unique DC/OS commands…Read More