cli

README

OpenFeature CLI

[!CAUTION] The OpenFeature CLI is experimental! Feel free to give it a shot and provide feedback, but expect breaking changes.

OpenFeature is an open specification that provides a vendor-agnostic, community-driven API for feature flagging that works with your favorite feature flag management tool or in-house solution.

Overview

The OpenFeature CLI is a command-line tool designed to improve the developer experience when working with feature flags. It helps developers manage feature flags consistently across different environments and programming languages by providing powerful utilities for code generation, flag validation, and more.

Installation

via curl

The OpenFeature CLI can be installed using a shell command. This method is suitable for most Unix-like operating systems.

curl -fsSL https://openfeature.dev/scripts/install_cli.sh | sh

via Docker

The OpenFeature CLI is available as a Docker image in the GitHub Container Registry.

You can run the CLI in a Docker container using the following command:

docker run -it -v $(pwd):/local -w /local ghcr.io/open-feature/cli:latest

via Go

If you have Go >= 1.23 installed, you can install the CLI using the following command:

go install github.com/open-feature/cli/cmd/openfeature@latest

via pre-built binaries

Download the appropriate pre-built binary from the releases page.

Quick Start

1. Create a flag manifest file in your project root:

cat > flags.json << EOL
{
  "$schema": "https://raw.githubusercontent.com/open-feature/cli/refs/heads/main/schema/v0/flag-manifest.json",
  "flags": {
    "enableMagicButton": {
      "flagType": "boolean",
      "defaultValue": false,
      "description": "Activates a special button that enhances user interaction with magical, intuitive functionalities."
    }
  }
}
EOL

[!NOTE] This is for demonstration purposes only. In a real-world scenario, you would typically want to fetch this file from a remote flag management service. See here, more more details.

1. Generate code for your preferred language:

openfeature generate react

See here for all available options.

1. View the generated code:

cat openfeature.ts

Congratulations! You have successfully generated your first strongly typed flag accessors. You can now use the generated code in your application to access the feature flags. This is just scratching the surface of what the OpenFeature CLI can do. For more advanced usage, read on!

Commands

The OpenFeature CLI provides the following commands:

init

Initialize a new flag manifest in your project.

openfeature init

See here, for all available options.

generate

Generate strongly typed flag accessors for your project.

# Available languages
openfeature generate

# Basic usage
openfeature generate [language]

# With custom output directory
openfeature generate typescript --output ./src/flags

See here, for all available options.

version

Print the version number of the OpenFeature CLI.

openfeature version

See here, for all available options.

Flag Manifest

The flag manifest is a JSON file that defines your feature flags and their properties. It serves as the source of truth for your feature flags and is used by the CLI to generate strongly typed accessors. The manifest file should be named flags.json and placed in the root of your project.

Flag Manifest Structure

The flag manifest file should follow the JSON schema defined here.

The schema defines the following properties:

• $schema: The URL of the JSON schema for validation.
• flags: An object containing the feature flags.
  • flagKey: A unique key for the flag.
    • description: A description of what the flag does.
    • type: The type of the flag (e.g., boolean, string, number, object).
    • defaultValue: The default value of the flag.

Example Flag Manifest

{
  "$schema": "https://raw.githubusercontent.com/open-feature/cli/refs/heads/main/schema/v0/flag-manifest.json",
  "flags": {
    "uniqueFlagKey": {
      "description": "Description of what this flag does",
      "type": "boolean|string|number|object",
      "defaultValue": "default-value",
    }
  }
}

Configuration

The OpenFeature CLI uses an optional configuration file to override default settings and customize the behavior of the CLI. This file can be in JSON or YAML format and should be named either .openfeature.json or .openfeature.yaml.

Configuration File Structure

# Example .openfeature.yaml
manifest: "flags/manifest.json" # Overrides the default manifest path
generate:
  output: "src/flags" # Overrides the default output directory
  # Any language-specific options can be specified here
  # For example, for React:
  react:
    output: "src/flags/react" # Overrides the default React output directory
  # For Go:
  go:
    package: "github.com/myorg/myrepo/flags" # Overrides the default Go package name
    output: "src/flags/go" # Overrides the default Go output directory

Configuration Priority

The CLI uses a layered approach to configuration, allowing you to override settings at different levels. The configuration is applied in the following order:

flowchart LR
  default("Default Config")
  config("Config File")
  args("Command Line Args")
  default --> config
  config --> args

Get Involved

• CNCF Slack: Join the conversation in the #openfeature and #openfeature-cli channel
• Regular Meetings: Attend our community calls
• GitHub Issues: Report bugs or request features in our issue tracker
• Social Media:
  • Twitter: @openfeature
  • LinkedIn: OpenFeature

For more information, visit our community page.

Support the project

• Give this repo a ⭐️!
• Share your experience and contribute back to the project

Thanks to everyone who has already contributed

Made with contrib.rocks.