Flagsmith

https://docs.flagsmith.com
Admin
Flagsmith is a platform for managing feature flags and remote configuration across web, mobile, and...
Tokens:155,619
Snippets:1,688
Trust Score:9.4
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install dependencies with npm install

Source: https://docs.flagsmith.com/project-and-community/development

Installs the dependencies for the documentation site. Run this before starting local development.

```bash
npm install  
```

--------------------------------

### Install Go SDK with go get

Source: https://docs.flagsmith.com/integrating-with-flagsmith/sdks/server-side

Install the Flagsmith Go client using go get. Requires Go 1.18 or newer.

```bash
go get github.com/Flagsmith/flagsmith-go-client
```

--------------------------------

### HTML page with button for Flagsmith quickstart

Source: https://docs.flagsmith.com/getting-started/quick-start

A minimal HTML page that will host the Flagsmith quickstart button. Used as the starting point before adding the SDK.

```html
<!doctype html>  

<html lang="en">  

 <head>  

  <meta charset="utf-8" />  

  <title>Flagsmith Quickstart Guide</title>  

 </head>  

 <body>  

  <h1>Here's our button!</h1>  

  <div id=
```

--------------------------------

### Install Flagsmith CLI with install script

Source: https://docs.flagsmith.com/integrating-with-flagsmith/CLI

Downloads and runs the official install script from get.flagsmith.com.

```bash
curl -fsSL https://get.flagsmith.com | sh  
```

--------------------------------

### Start local development server with make serve

Source: https://docs.flagsmith.com/project-and-community/development

Starts a local development server and opens a browser window. Most changes are reflected live without restarting the server.

```bash
make serve  
```

--------------------------------

### Download and start Flagsmith with Docker Compose

Source: https://docs.flagsmith.com/deployment-self-hosting/hosting-guides/docker

Downloads the Flagsmith docker-compose.yml and starts the full environment. Wait for images to download and run, then visit http://localhost:8000/ and create an account at http://localhost:8000/signup.

```bash
curl -o docker-compose.yml https://raw.githubusercontent.com/Flagsmith/flagsmith/main/docker-compose.yml  

docker-compose -f docker-compose.yml up  

```

--------------------------------

### Install Sentry SDK and Flagsmith OpenFeature provider

Source: https://docs.flagsmith.com/third-party-integrations/observability-and-monitoring/sentry

Install the Sentry SDK with OpenFeature support and the Flagsmith OpenFeature provider.

```bash
pip install "sentry-sdk[openfeature]"  

pip install openfeature-provider-flagsmith  
```

--------------------------------

### Install Flagsmith React SDK with npm

Source: https://docs.flagsmith.com/integrating-with-flagsmith/sdks/client-side-sdks/react

Install the Flagsmith React SDK via npm.

```bash
npm i @flagsmith/flagsmith --save  
```

--------------------------------

### Install Ruby SDK with gem

Source: https://docs.flagsmith.com/integrating-with-flagsmith/sdks/server-side

Install the Flagsmith Ruby client using gem. Requires Ruby 2.4 or newer.

```bash
gem install flagsmith
```

--------------------------------

### Install .NET SDK via Package Manager console

Source: https://docs.flagsmith.com/integrating-with-flagsmith/sdks/server-side

Install the Flagsmith .NET client using the Package Manager console. Requires .NET core 6.0 or newer.

```powershell
Install-Package Flagsmith -Version 8.0.2
```

--------------------------------

### Start Oracle Database with Docker Compose

Source: https://docs.flagsmith.com/deployment-self-hosting/enterprise-edition

Start the Oracle database container using the provided docker-compose.oracle.yml file. Requires Docker Hub registration for Oracle Enterprise Edition images.

```bash
docker-compose -f docker-compose.oracle.yml up db  
```

--------------------------------

### AppDynamics configuration file example (appdynamics.template.cfg)

Source: https://docs.flagsmith.com/deployment-self-hosting/observability/monitoring

Configuration file provided by the AppDynamics 

```ini
appdynamics.template.cfg
```

--------------------------------

### Get Identity Flags API call

Source: https://docs.flagsmith.com/third-party-integrations/analytics/rudderstack

Example of the API call made by the Flagsmith SDK to the Get Identity Flags endpoint. The response contains the full set of flag evaluations for the user, which are sent to RudderStack.

```bash
curl 'https://edge.api.flagsmith.com/api/v1/identities/?identifier=development_user_1'
```

--------------------------------

### init(initialisationOptions) => Promise<void>

Source: https://docs.flagsmith.com/integrating-with-flagsmith/sdks/client-side-sdks/javascript

Initialises the SDK against a particular environment. This must be called before using other SDK functions.

```APIDOC
## init(initialisationOptions) => Promise<void>

### Description
Initialises the SDK against a particular environment.

### Method
init

### Parameters
- **initialisationOptions** (object) - Required - Options for initialisation, typically including environment key and other configuration.

### Returns
- **Promise<void>** - Resolves when initialisation is complete.

### Example
```javascript
await flagsmith.init({ environmentKey: 'your_env_key' });
```
```

--------------------------------

### Get Identity Flags with curl

Source: https://docs.flagsmith.com/third-party-integrations/analytics/amplitude

Example curl command to fetch identity flags from the Flagsmith API. The response is sent to Amplitude as flag evaluations for the user.

```bash
curl 'https://edge.api.flagsmith.com/api/v1/identities/?identifier=development_user_123456' \
  -H 'X-Environment-Key: 8KzETdDeMY7xkqkSkY3Gsg'
```

--------------------------------

### Example GatewayClass and Gateway resources for Envoy Gateway

Source: https://docs.flagsmith.com/deployment-self-hosting/hosting-guides/kubernetes-openshift

Defines a GatewayClass and Gateway resource using Envoy Gateway as the controller. Install these before enabling HTTPRoutes in the chart.

```yaml
apiVersion: gateway.networking.k8s.io/v1  

kind: GatewayClass  

metadata:  

  name: eg  

spec:  

  controllerName: gateway.envoyproxy.io/gatewayclass-controller  

---  

apiVersion: gateway.networking.k8s.io/v1  

kind: Gateway  

metadata:  

  name: my-gateway  

  namespace: gateway-ns  

spec:  

  gatewayClassName: eg  

  listeners:  

    - name: http  

      port: 80  

      protocol: HTTP  

      allowedRoutes:  

        namespaces:  

          from: All  

```

--------------------------------

### Example response from GET /processor/monitoring

Source: https://docs.flagsmith.com/deployment-self-hosting/scaling-and-performance/asynchronous-task-processor

Shows the JSON response returned by the task processor statistics endpoint. The response contains a single field 'waiting' with the number of tasks waiting in the queue.

```json
{
  
 "waiting": 1  // The number of tasks waiting in the queue.  
}   

```

--------------------------------

### Flagsmith CLI Quickstart

Source: https://docs.flagsmith.com/integrating-with-flagsmith/CLI

Initializes a flagsmith.json file and lists flags in the current environment.

```bash
flagsmith init          # log in, pick a project + environment, write flagsmith.json  
```

```bash
flagsmith flag list     # list the flags in the current environment
```

--------------------------------

### Start API and database with Docker Compose

Source: https://docs.flagsmith.com/project-and-community/development

Downloads the Flagsmith docker-compose.yml and starts the API and database containers. The application bootstraps an admin user, organisation, and project, and prints a password-setup link in the Compose logs.

```bash
curl -o docker-compose.yml https://raw.githubusercontent.com/Flagsmith/flagsmith/main/docker-compose.yml  

docker-compose -f docker-compose.yml up  
```

--------------------------------

### Run dev server on 0.0.0.0 with npm run start

Source: https://docs.flagsmith.com/project-and-community/development

Runs the dev server on 0.0.0.0 to listen on the local IP when forwarding port 3000 from a remote server or VM.

```bash
npm run start -- --host 0.0.0.0  
```

--------------------------------

### Install Gateway API CRDs

Source: https://docs.flagsmith.com/deployment-self-hosting/hosting-guides/kubernetes-openshift

Install the Gateway API CRDs before enabling HTTPRoutes. Run this command to apply the standard installation manifest from the Gateway API release.

```bash
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/latest/download/standard-install.yaml  
```

--------------------------------

### Install Flagsmith CLI with Homebrew

Source: https://docs.flagsmith.com/integrating-with-flagsmith/CLI

Installs the Flagsmith CLI binary via Homebrew on macOS/Linux.

```bash
brew install Flagsmith/tap/flagsmith  
```

--------------------------------

### Install .NET SDK via Paket CLI

Source: https://docs.flagsmith.com/integrating-with-flagsmith/sdks/server-side

Add the Flagsmith .NET client using the Paket CLI. Requires .NET core 6.0 or newer.

```bash
paket add Flagsmith --version 8.0.2
```

--------------------------------

### Install Flagsmith Helm chart

Source: https://docs.flagsmith.com/deployment-self-hosting/hosting-guides/kubernetes-openshift

Installs the Flagsmith Helm chart in a new namespace named flagsmith.

```bash
helm install -n flagsmith --create-namespace flagsmith flagsmith/flagsmith  
```

--------------------------------

### Example output of generated rollback commands

Source: https://docs.flagsmith.com/deployment-self-hosting/administration-and-maintenance/upgrades-and-rollbacks

Example output from the rollback command generation query. Shows the generated python manage.py migrate commands for each app, including 'zero' for the first migration.

```text
                python_commands  

-----------------------------------------------  

 python manage.py migrate multivariate 0007  

 python manage.py migrate segment 0004  

 python manage.py migrate environments 0034  

 python manage.py migrate features 0064  

 python manage.py migrate token_blacklist zero  


```

--------------------------------

### Install Flagsmith CLI via NPM

Source: https://docs.flagsmith.com/integrating-with-flagsmith/CLI

Installs the Flagsmith CLI globally using the npm package manager.

```bash
npm install -g @flagsmith/cli
```

--------------------------------

### Install .NET SDK via .NET CLI

Source: https://docs.flagsmith.com/integrating-with-flagsmith/sdks/server-side

Add the Flagsmith .NET client using the .NET CLI. Requires .NET core 6.0 or newer.

```bash
dotnet add package Flagsmith --version 8.0.2
```
Tokens:
Raw