Skip to content

drove config

Manage CLI configuration. These commands work offline.

Synopsis

drove config <command> [options]

Commands

Command Description
get-clusters List configured clusters
current-cluster Show default cluster
use-cluster Set default cluster
view Show config file
init Create new config
add-cluster Add a cluster
delete-cluster Remove a cluster

drove config get-clusters

List all configured clusters.

drove config get-clusters

Output:

CURRENT    NAME        ENDPOINT                         AUTH   INSECURE
------------------------------------------------------------------------
*          prod        https://drove.example.com        yes    no
           staging     https://drove-stg.example.com    yes    yes

Current cluster: prod


drove config current-cluster

Show the current default cluster.

drove config current-cluster

drove config use-cluster

Set the default cluster.

drove config use-cluster <cluster-name>

Example:

drove config use-cluster staging
# Switched to cluster "staging".


drove config view

Display the config file.

drove config view [--raw]
Option Description
-r, --raw Show raw file content

drove config init

Create a new ~/.drove config file.

drove config init --endpoint URL [--name NAME] [--username USER] [--password PASS] \
    [--auth-header TOKEN] [--insecure]

Example:

drove config init -e https://drove.example.com -n prod -t "Bearer xxx"

Note

If ~/.drove already exists, this command will fail. Use drove config add-cluster to add clusters to an existing config.


drove config add-cluster

Add a cluster to existing config.

drove config add-cluster <name> --endpoint URL [--username USER] [--password PASS] \
    [--auth-header TOKEN] [--insecure]

Example:

drove config add-cluster staging -e https://drove-stg.example.com -u admin -p secret -i


drove config delete-cluster

Remove a cluster from config.

drove config delete-cluster <name>

Note

If you delete the current default cluster, you'll need to set a new default with use-cluster.