Skip to content

CLI Usage

cub is the command-line tool for using ConfigHub.

Installation

You can install the CLI with the following one-liner:

curl -fsSL https://hub.confighub.com/cub/install.sh | bash

The CLI is a single binary which will be saved to ~/.confighub/bin/cub. The script will also download the worker binary cub-worker-run and place it in the same directory. You need to add cub to your path. You can do that in a variety of ways:

  • sudo ln -sf ~/.confighub/bin/cub /usr/local/bin/cub
  • ln -sf ~/.confighub/bin/cub ~/bin/cub
  • export PATH=~/.confighub/bin/cub:$PATH

etc.

The CLI binary is available for Linux and Mac, ARM64 and AMD64 architectures as well as a Windows AMD64 binary which does not yet have an install script.

Getting started

To get credentials:

cub auth login

And login using your browser.

To set the default space, where SPACE is set to the slug of a space you have access to within the organization you are logged into:

cub context set --space $SPACE

To get your current context:

cub context get

General CLI Usage patterns

The cub CLI follows the pattern of:

cub <entity/area> <verb> [<flags>] [<arguments>]

For example:

cub unit create --space prod-eu deployment deployment.yaml

For more information

Use cub --help for detailed command help and cub --help-overview for an up-to-date usage overview.

A CLI reference is also available in the documentation.