@launchdarkly/ldcli

LaunchDarkly CLI

The LaunchDarkly CLI helps you manage your feature flags from your terminal or your IDE.

With the CLI, you can:

• Create and evaluate your first feature flag with a guided setup command.
• Onboard your whole team by inviting new members.
• Interact with the LaunchDarkly API using resource- and CRUD-based commands.

Installation

The LaunchDarkly CLI is available for macOS, Windows, and Linux.

macOS

The CLI is available on macOS via Homebrew:

brew tap launchdarkly/homebrew-tap
brew install ldcli

Windows

A Windows executable of ldcli is available on the releases page.

Linux

A Linux executable of ldcli is available on the releases page.

Additional installations

You can also install the LaunchDarkly CLI using npm or Docker.

npm

Install with npm:

npm install -g @launchdarkly/ldcli

Docker

Pull from Docker:

docker pull launchdarkly/ldcli

Usage

Installing the CLI provides access to the ldcli command.

ldcli [command]

# Run `--help` for detailed information about CLI commands
ldcli --help

Configuration

The LaunchDarkly CLI allows you to save preferred settings, either as environment variables or within a config file. Use the config commands to save your settings.

Supported settings:

• access-token A LaunchDarkly access token with write-level access
• analytics-opt-out Opt out of analytics tracking (default false)
• base-uri LaunchDarkly base URI (default "https://app.launchdarkly.com")

• environment: Default environment key
• flag: Default feature flag key
• output: Output format: json or plaintext (default: plaintext in a terminal, json otherwise)
• project: Default project key

Available config commands:

• config --set {key} {value}
• config --unset {key}
• config --list

To save a setting as an environment variable, prepend the variable name with LD. For example:

export LD_ACCESS_TOKEN=api-00000000-0000-0000-0000-000000000000

To save a setting in the configuration file:

ldcli config --set access-token api-00000000-0000-0000-0000-000000000000

Running this command creates a configuration file located at $XDG_CONFIG_HOME/ldcli/config.yml with the access token. Subsequent commands read from this file, so you do not need to specify the access token each time.

Output format defaults

When you do not pass --output or --json, the default format depends on whether standard output is a terminal: plaintext in an interactive terminal, json when stdout is not a TTY (for example when piped, in CI, or in agent environments).

To force the plaintext default even when stdout is not a TTY, set either FORCE_TTY or LD_FORCE_TTY to any non-empty value (similar to tools that use NO_COLOR). That only affects the default; explicit --output, --json, LD_OUTPUT, and the output setting in your config file still apply.

LD_OUTPUT is the same setting as output in the config file, exposed as an environment variable (see the LD_ prefix above). It is not new with TTY detection; the test suite locks in that it overrides the non-TTY JSON default when set to plaintext.

Effective output is resolved in this order: --json (if set, wins over --output when both are present), then --output, then LD_OUTPUT, then the output value from your config file, then the TTY-based default above.

Commands

LaunchDarkly CLI commands:

• setup guides you through creating your first flag, connecting an SDK, and evaluating your flag in your Test environment
• dev-server lets you start a local server and retrieve flag values from a LaunchDarkly source environment so you can test your code locally. For assistance starting with or running dev-server, refer to the reference docs.

Resource Commands

Resource commands mirror the LaunchDarkly API and make requests for a given resource. To see a full list of resources supported by the CLI, enter ldcli --help into your terminal.

To see the commands available for a given resource:

ldcli <resource> --help

Here is an example command to create a flag:

ldcli flags create --access-token <access-token> --project default --data '{"name": "My Test Flag", "key": "my-test-flag"}'

Documentation

Additional documentation is available at https://docs.launchdarkly.com/home/getting-started/ldcli.

Contributing

We encourage pull requests and other contributions from the community. Check out our contributing guidelines for instructions on how to contribute to this project.

Running a local build of the CLI

If you wish to test your changes locally, simply

• Clone this repo to your local machine;
• Run make build from the repo root;
• Run commands as usual with ./ldcli.

Verifying build provenance with the SLSA framework

LaunchDarkly uses the SLSA framework (Supply-chain Levels for Software Artifacts) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published packages. To learn more, see the provenance guide.

About LaunchDarkly

• LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
  • Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
  • Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
  • Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
  • Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
• LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read our documentation for a complete list.
• Explore LaunchDarkly
  • launchdarkly.com for more information
  • docs.launchdarkly.com for our documentation and SDK reference guides
  • apidocs.launchdarkly.com for our API documentation
  • blog.launchdarkly.com for the latest product updates