Flipt Documentation

Flipt v2 Pro provides enterprise-grade features for Git-native feature management.

Key Features

• Enterprise DevOps Integration: Native workflows for GitHub, GitLab, BitBucket, Azure DevOps, and Gitea (includes merge proposals and automated PR/MR creation).
• GPG Commit Signing: Cryptographic signing of changes for security and auditability.
• Integrated Secrets Management: Secure storage for GPG keys with integration for HashiCorp Vault, AWS Secrets Manager, GCP Secret Manager, and Azure Key Vault.
• Air-Gapped Support: Annual licenses support offline validation for air-gapped environments.
• Enterprise Auth & Advanced Analytics: (Coming soon).

Pricing Models

• Free 14-day trial: Includes all Pro features (up to 5 instances).
• Monthly License: $200/month (requires continuous internet connectivity).
• Annual License: $2,000/year (supports offline validation via license files).
• Instance Limits: Paid plans include unlimited instances.

When building interactive CLI commands for Flipt, use a structured wizard pattern to guide users through multiple steps. This involves checking for a TTY (interactive terminal), managing the current step state, and executing a sequence of step functions. Ensure you handle user interruptions (like Ctrl+C) gracefully by checking for interrupt errors.

type myCommand struct {
    // Configuration
    configFile string
    
    // Wizard state
    currentStep WizardStep
    totalSteps  int
    
    // User inputs
    userInput string
}

func (c *myCommand) run(cmd *cobra.Command, args []string) error {
    // 1. Check TTY
    if !isatty.IsTerminal(os.Stdout.Fd()) {
        return fmt.Errorf("requires interactive terminal")
    }
    
    // 2. Initialize
    c.currentStep = StepWelcome
    c.totalSteps = 4
    
    // 3. Run wizard steps
    steps := []wizardStep{
        {StepWelcome, c.runWelcomeStep},
        {StepConfig, c.runConfigStep},
        {StepValidate, c.runValidateStep},
    }
    
    for _, step := range steps {
        c.currentStep = step.step
        fmt.Print("\033[H\033[2J")  // Clear screen
        
        if err := step.runFunc(); err != nil {
            if isInterruptError(err) {
                fmt.Println(HelperTextStyle.Render("Cancelled."))
                return nil
            }
            return err
        }
    }
    
    // 4. Show success
    c.currentStep = StepComplete
    c.renderSuccessScreen()
    
    return nil
}

Follow these patterns to ensure errors are helpful and user interruptions are handled gracefully.

Error Display Pattern Avoid duplicating error messages. Use ErrorStyle for the main failure message and LabelStyle + ValueStyle for the specific error detail.

fmt.Println(ErrorStyle.Render("✗ Operation failed"))
fmt.Println(LabelStyle.Render("Error: ") + ValueStyle.Render(err.Error()))
fmt.Println()
fmt.Println(HelperTextStyle.Render("Try this to fix the issue"))
return nil // Return nil to prevent Cobra from printing error again

User Interrupts Detect if a user aborted the process (e.g., via Ctrl+C) by checking for tea.ErrInterrupted or huh.ErrUserAborted using errors.Is().

// Don't duplicate error messages
fmt.Println(ErrorStyle.Render("✗ Operation failed"))
fmt.Println(LabelStyle.Render("Error: ") + ValueStyle.Render(err.Error()))
fmt.Println()
fmt.Println(HelperTextStyle.Render("Try this to fix the issue"))
return nil  // Return nil to prevent Cobra from printing error again

To develop Flipt locally, ensure you have the following requirements installed:

• GCC Compiler
• mise (manages Go, Node, and other tool versions)
• Docker (for running unit tests)
• Playwright (optional, for running UI tests)
• Dagger (optional, for running integration tests)

Follow these steps to initialize the environment:

1. Clone the repository: git clone https://github.com/flipt-io/flipt.
2. Install required tool versions: mise install.
3. Install development tools: mise run bootstrap.
4. Run the Go test suite: mise run test.
5. Build the binary with embedded assets: mise run build.
6. View all available commands: mise tasks.

Alternatively, you can use devenv by running devenv up from the root of the repository to start a development environment with the server on port 8080 and the UI dev server on port 5173.