Documentation

CLI

Since 1.2.0, Flipper comes with a CLI to inspect the current state of your feature flags, and to enable or disable them.

Installation

The Flipper CLI is distributed as part of the flipper gem. Add it to your Gemfile with:

$ bundle add flipper

Or install it yourself with:

$ gem install flipper

Usage

$ flipper --help
Usage: flipper [options] <command>

Commands:
  enable    Enable a feature
  disable   Disable a feature
  list      List defined features
  show      Show a defined feature

Options:
    -r path                          The path to load your application. Default: ./config/environment
    -h, --help                       Print help message

Examples

You can list your features:

$ bundle exec flipper list
administrator          is ◯ enabled for 1 actor
docsearch              is ⏺ enabled
expressions            is ◯ enabled for an expression
github_auth            is ⏺ enabled
google_auth            is ⏺ enabled
hubspot                is ⏺ enabled
rack_mini_profiler     is ⏺ enabled
scoped_tokens          is ⏺ enabled
seo                    is ⏺ enabled
subscriptions          is ⏺ enabled
telemetry_receiving    is ⏺ enabled
trial_on_create        is ⏺ enabled
trial_lifecycle_emails is ⏺ enabled
webhooks               is ⏺ enabled
adapter_request_logs   is ⦸ disabled
github_sync            is ⦸ disabled
helpscout              is ⦸ disabled
plausible              is ⏺ enabled
plausible_masked       is ⦸ disabled
neutral_edit_feature   is ⏺ enabled
feature_stats          is ⏺ enabled
stats                  is ⦸ disabled
version_check          is ⏺ enabled
userlist_onboarding    is ⏺ enabled
new_landing            is ⏺ enabled

Look at a specific feature:

bundle exec flipper show administrator
administrator is ◯ conditionally enabled for:
  1 actor
  - User;830138774

And enable or disable a feature:

bundle exec flipper disable plausible
plausible is ⦸ disabled