CLI Plugins

How to extend the command line interface

Plugins extend the functionality of the CLI for cluster specific actions.

Plugins are cluster-specific; when switching between different clusters, the CLI will automatically use the proper set of plugins installed for that cluster.

Core CLI Plugin

Commands that are specific to a DC/OS version are packaged into a plugin called dcos-core-cli. The CLI automatically installs the core plugin during dcos cluster setup.

The subcommands included in this plugin are:

CommandDescription
dcos jobDeploy and manage jobs in DC/OS.
dcos marathonDeploy and manage applications to DC/OS.
dcos nodeAdminister and manage DC/OS cluster nodes.
dcos packageInstall and manage DC/OS software packages.
dcos serviceManage DC/OS services.
dcos taskManage DC/OS tasks.

Enterprise CLI Plugin

Commands that are specific to a DC/OS EE version are packaged into a plugin called dcos-enterprise-cli.

The CLI automatically installs this plugin during dcos cluster setup when it detects a DC/OS EE cluster.

The subcommands included in this plugin are:

CommandDescription
dcos backupAccess DC/OS backup functionality.
dcos licenseManage your DC/OS licenses.
dcos securityDC/OS security related commands.

Installing plugins

Users can install plugins using the dcos plugin add command. You can find plugin URLs by browsing the https://downloads.dcos.io/cli/index.html webpage.

Plugins can also be installed through the dcos package command in the core CLI.

Updating Core and Enterprise plugins

The simplest way to update the Core and Enterprise plugins is to re-run the dcos cluster setup command.

Another way is to update them through Cosmos :

  1. dcos package install <dcos-core-cli|dcos-enterprise-cli>

Alternatively, you can find new versions of these plugins by browsing the https://downloads.dcos.io/cli/index.html webpage, and run the dcos plugin add command with the --update command-line option.