flipper

[![Flipper Mark](https://raw.githubusercontent.com/flippercloud/flipper/main/docs/images/banner.jpg)](https://www.flippercloud.io)

[Website](https://flippercloud.io?utm_source=oss&utm_medium=readme&utm_campaign=website_link) | [Documentation](https://flippercloud.io/docs?utm_source=oss&utm_medium=readme&utm_campaign=docs_link) | [Examples](https://github.com/flippercloud/flipper/tree/main/examples) | [Chat](https://chat.flippercloud.io/join/xjHq-aJsA-BeZH) | [Twitter](https://twitter.com/flipper_cloud) | [Ruby.social](https://ruby.social/@flipper)

# Flipper

> Beautiful, performant feature flags for Ruby and Rails.

Flipper gives you control over who has access to features in your app.

- Enable or disable features for everyone, specific actors, groups of actors, a percentage of actors, or a percentage of time.
- Configure your feature flags from the console or a web UI.
- Regardless of what data store you are using, Flipper can performantly store your feature flags.
- Use [Flipper Cloud](#flipper-cloud) to cascade features from multiple environments, share settings with your team, control permissions, keep an audit history, and rollback.

Control your software — don't let it control you.

## Installation

### Rails

```
bundle add flipper-active_record
bin/rails g flipper:setup
bin/rails db:migrate
```

`flipper-active_record` brings in `flipper` and stores your features in your database. `flipper:setup` creates `config/initializers/flipper.rb` and the migration. Prefer Redis, Sequel, or something else? Pick another [adapter](https://flippercloud.io/docs/adapters). Add [`flipper-ui`](https://flippercloud.io/docs/ui) for a web UI.

To move your features to [Flipper Cloud](#flipper-cloud) later (free plan, no token needed to start):

```
bundle exec flipper cloud migrate
```

Cloud support is built into the `flipper` gem; the separate `flipper-cloud` gem is deprecated.

### Other Ruby apps

Add this line to your application's Gemfile:

    gem 'flipper'

You'll also want to pick a storage [adapter](https://flippercloud.io/docs/adapters), for example:

    gem 'flipper-redis'

And then execute:

    $ bundle

Or install it yourself with:

    $ gem install flipper

## Subscribe & Ship

[💌  Subscribe](https://www.flippercloud.io/newsletter) - we'll send you short and sweet emails when we release new versions ([examples](https://www.flippercloud.io/blog/tag/releases)).

## Merch

Do you deploy on Fridays? [👕 Get the tee](https://shop.verygoodsoftware.company/product/i-deploy-on-fridays-tee?utm_source=oss&utm_medium=readme&utm_campaign=merch).

## Getting Started

Use `Flipper#enabled?` in your app to check if a feature is enabled.

```ruby
# check if search is enabled
if Flipper.enabled?(:search, current_user)
  puts 'Search away!'
else
  puts 'No search for you!'
end
```

All features are disabled by default, so you'll need to explicitly enable them.

```ruby
# Enable a feature for everyone
Flipper.enable :search

# Enable a feature