Flaggr Documentation

Welcome to the Flaggr documentation. Flaggr is an open-source, OpenFeature-compatible feature flag platform with real-time targeting, type-safe SDKs, and built-in observability.

Getting Started

• Concepts — Core data model, evaluation flow, and terminology
• Quick Start — Get up and running in under 5 minutes
• Installation — Install the SDK and configure your environment
• CLI — Install and use the Flaggr CLI

SDK Reference

• Client SDK — TypeScript client API reference
• React Hooks — React hooks for flag evaluation
• TypeScript SDK — Standalone @flaggr/sdk package
• Go SDK — Connect-RPC and gRPC client for Go
• Python SDK — REST API and OFREP integration for Python
• Type Reference — Core TypeScript types and interfaces

API & Protocols

• API Explorer — Interactive Connect-RPC API reference
• API Tokens — Authentication and token management
• Protocols — REST, gRPC, Connect-RPC, OFREP, SSE
• REST API Reference — Complete endpoint reference
• OFREP Protocol — OpenFeature Remote Evaluation Protocol v1

Platform

• Environments — Multi-environment flag configuration
• Deployment — Vercel, Docker, Cloud Run, and infrastructure setup
• Audit Logging — Track every change
• Alerting — Built-in health monitoring
• Authentication & Tokens — Auth methods, roles, permissions
• Roles & Permissions — RBAC matrix and token scopes

Trust Center

• Security & Trust — Security baseline and control areas
• Data Retention — Retention and deletion expectations
• Data Processing & Privacy — Processing model and privacy commitments
• Incident Disclosure — Incident communication and follow-up
• Security Questionnaire — Enterprise security review response pack

Core Flows

• Creating Flags — End-to-end guide to creating feature flags
• Managing Flags — Editing, toggling, targeting rules, rollouts, and overrides
• Monitoring Flags — Health scoring, impact analysis, debugging, and alerts

Guides

• Flag Lifecycle & Best Practices — Plan, create, roll out, and retire flags
• Targeting Rules — Conditional delivery, operators, rollouts
• Cohorts — Reusable audience segments for targeting
• Progressive Rollouts — Staged deployment with safety checks
• Overrides & Prerequisites — Identity overrides and flag dependencies
• Scheduled Rules — Time-based rule activation
• Experiments & A/B Testing — Variant assignment, metrics, and statistical analysis
• Mutual Exclusion — Prevent experiment interference
• Import/Export — Export and import flag configurations
• Flag Versioning — Automatic snapshots, history, and rollback
• Infrastructure as Code — CI/CD automation and flag definitions in version control
• Flag Health — Health monitoring and auto-remediation
• Command Palette — Keyboard-driven navigation (Cmd+K)
• Provider Architecture — Choose the right evaluation provider
• Webhooks — Real-time event notifications
• Caching Strategy — Three-tier cache architecture
• Rate Limiting — IP, token, and service-level limits
• Real-Time Updates — SSE and gRPC streaming
• Advanced Evaluation — Consistent hashing and rollouts
• Edge Deployment — Edge and serverless providers
• Performance — Latency benchmarks and optimization
• Migration Guide — Migrate between protocols and platforms
• Troubleshooting — Common issues and solutions