Cli

<!-- markdownlint-disable MD033 --> <!-- x-hide-in-docs-start --> <p align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/white/openfeature-horizontal-white.svg" /> <img align="center" alt="OpenFeature Logo" src="https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/black/openfeature-horizontal-black.svg" /> </picture> </p> <h2 align="center">OpenFeature CLI</h2> <!-- x-hide-in-docs-end --> <!-- The 'github-badges' class is used in the docs --> <p align="center" class="github-badges"> <a href="https://github.com/orgs/open-feature/projects/17"> <img alt="work-in-progress" src="https://img.shields.io/badge/status-WIP-yellow" /> </a> <a href="https://cloud-native.slack.com/archives/C07DY4TUDK6"> <img alt="Slack" src="https://img.shields.io/badge/slack-%40cncf%2Fopenfeature-brightgreen?style=flat&logo=slack" /> </a> </p> <!-- x-hide-in-docs-start -->

[!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

<!-- x-hide-in-docs-end -->

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.

The CLI bridges the gap between feature flag management systems and your application code by generating strongly typed flag accessors from a flag manifest. This approach provides:

• Type Safety: Generate strongly-typed flag accessors for your preferred language
• Developer Experience: Reduce errors and improve IDE autocomplete support
• Language Support: Generate code for TypeScript, JavaScript, React, Go, C#, 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 details.

2. Generate code for your preferred language:

openfeature generate react

See here for all available options.

3. 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:

| Command | Description | |---------|-------------| | init | Initialize a new flag manifest | | manifest | Manage flag manifest files (add, list, delete) | | compare | Compare two flag manifests | | generate | Generate strongly typed flag accessors | | pull | Fetch flags from remote sources | | push | Push flags to remote services | | version | Display CLI version |

init

Initialize a new flag manifest in your project.

openfeature init

This command creates a flags.json file in your current directory with the proper schema reference. You can customize the manifest path using configuration options.

See here for all available options.

manifest

Manage flag manifest files with subcommands for adding, listing, and deleting flags.

# Add a new flag interactively
openfeature manifest add

# Add a boolean flag
openfeature manifest add new-feature --default-value false

# Add a string flag with description
openfeature manifest add welcome-message \
  --type string \
  --default-value "Hello!" \
  --description "Welcome message for users"

# List all flags in the manifest
openfeature manifest list

# Delete a flag from the manifest
openfeature manifest delete old-feature

The manifest command provides:

• add: Add new flags to your manifest file
• list: Display all flags with their configuration
• delete: Remove flags from your manifest file

See here for all available options.

compare

Compare two feature flag manifests and display the differences.

# Compare your local manifest against another
openfeature compare --against production-flags.json

# Compare with different output formats
openfeature compare --against other.json --output json
openfeature compare --against other.json --output yaml
openfeature compare --against other.json --output flat

Output formats:

• tree: Hierarchical tree view (default)
• flat: Simple flat list
• json: JSON format
• yaml: YAML format

See here for all available options.

generate

Generate strongly typed flag accessors for your project.

# List available languages
openfeature generate

# Generate for a specific language
openfeature generate typescript

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

Supported Languages:

| Language | Description | |----------|-------------| | react | React hooks for feature flags | | go | Go flag accessors | | csharp | C# flag accessors | | java | Java flag accessors | | python | Python flag accessors | | nestjs | NestJS flag accessors | | nodejs | Node.js flag accessors | | angular | Angular flag accessors |

See here for all available options.

NOTE: Angular generated code requires @openfeature/angular-sdk version 1.1.0 or newer.

pull

Fetch feature flag configurations from a remote source.

# Pull flags from a remote API
openfeature pull --flag-source-url https://api.example.com

# With authentication
openfeature pull --flag-source-url https://api.example.com --auth-token secret-token

# Pull from a JSON file URL
openfeature pull --flag-source-url https://example.com/flags.json

The pull command supports:

• HTTP/HTTPS endpoints implementing the OpenFeature Manifest Management API
• Direct JSON/YAML file URLs
• Authentication via bearer tokens

See here for all available options.

push

Push local flag configurations to a remote flag management service.

# Push flags to a remote API
openfeature push --flag-source-url https://api.example.com --auth-token secret-token

# Dry run to preview changes
openfeature push --flag-source-url https://api.example.com --dry-run

The push command intelligently:

• Fetches existing flags from the remote
• Compares local flags with remote flags
• Creates new flags that don't exist remotely
• Updates existing flags that have changed

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 with 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 (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",
    }
  }
}

Remote Flag Ma