Documentation

We are here to help you get from zero to one fast.

Get Started    Discussions

Doppler CLI Guide

reading time 4 minutes

Installation

The Doppler CLI provides a consistent experience when developing locally to production. It is a lightweight binary that comes provided in a number of package managers and Docker images. Check out the Doppler CLI repository on GitHub!

brew install dopplerhq/cli/doppler
# Add Doppler's scoop repo
scoop bucket add doppler https://github.com/DopplerHQ/scoop-doppler.git

# Install latest doppler cli
scoop install doppler
# All tags: https://hub.docker.com/r/dopplerhq/cli/tags
#   - Alpine: dopplerhq/cli:2
#   - Node: dopplerhq/cli:2-node
#   - Python: dopplerhq/cli:2-python
#   - Ruby: dopplerhq/cli:2-ruby
FROM dopplerhq/cli:2
# Add Bintray's GPG key
sudo apt-key adv --keyserver pool.sks-keyservers.net --recv-keys 379CE192D401AB61

# Add Doppler's apt repo
sudo echo "deb https://dl.bintray.com/dopplerhq/doppler-deb stable main" > /etc/apt/sources.list.d/dopplerhq-doppler.list

# Update packages and install latest doppler cli
sudo apt-get update && sudo apt-get install doppler
# Add Doppler's yum repo
sudo wget https://bintray.com/dopplerhq/doppler-rpm/rpm -O /etc/yum.repos.d/bintray-dopplerhq-doppler.repo

# Update packages and install latest doppler cli
sudo yum update && sudo yum install doppler

Now let's verify the Doppler CLI was installed correctly.

doppler --version

Authentication

The Doppler CLI requires an API key to authenticate. Access can be generated via the login flow used for local development OR by using a service token. Service tokens are recommended to be used only when running your service on a cloud provider (Azure, AWS, GCP, etc).

doppler login
# Option 1: Configure for late use
doppler configure set token <SERVICE TOKEN>

# Option 2: Pass as flag on any command
doppler --token=<SERVICE TOKEN> configure debug

# Option 3: Read from environment on any command
DOPPLER_TOKEN=<SERVICE TOKNE> doppler configure debug

List of Commands

The official Doppler CLI

Usage:
  doppler [flags]
  doppler [command]

Available Commands:
  activity    Get workplace activity logs
  configure   View the config file
  enclave     Control Enclave
  feedback    Provide feedback about the Doppler CLI
  help        Help about any command
  login       Authenticate to Doppler
  logout      Log out of the CLI
  open        open a web page in your browser
  run         Run a command with secrets injected into the environment
  settings    Get workplace settings

Flags:
      --api-host string         The host address for the Doppler API (default "https://api.doppler.com")
      --configuration string    config file (default "/Users/USERNAME/.doppler/.doppler.yaml")
      --dashboard-host string   The host address for the Doppler Dashboard (default "https://doppler.com")
      --debug                   output additional information when encountering errors
  -h, --help                    help for doppler
      --json                    output json
      --no-read-env             do not read enclave config from the environment
      --no-timeout              disable http timeout
      --no-update               disable checking for Doppler CLI updates
      --no-verify-tls           do not verify the validity of TLS certificates on HTTP requests (not recommended)
      --scope string            the directory to scope your config to (default ".")
      --timeout duration        max http request duration (default 10s)
  -t, --token string            doppler token
  -v, --version                 Get the version of the Doppler CLI

Use "doppler [command] --help" for more information about a command.

Updated 2 months ago



Doppler CLI Guide


reading time 4 minutes

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.