This is page 4 of 7. Use http://codebase.md/bucketco/docs/_media/.gitbook/assets/Screenshot%202025-09-02%20at%2017.19.44%20(1).png?lines=true&page={x} to view the full context.
# Directory Structure
```
├── .gitbook
│ ├── assets
│ │ ├── 03642c5-dwFrame_201 (1).png
│ │ ├── 03642c5-dwFrame_201.png
│ │ ├── 1753259671871 (1).jpeg
│ │ ├── 1a0b50d-image.png
│ │ ├── 1a439d9-image.png
│ │ ├── 2506596-Customized_Widgets.png
│ │ ├── 342658e-image.png
│ │ ├── 4017197-image.png
│ │ ├── 43e55f0-image.png
│ │ ├── 4783e3f-image.png
│ │ ├── 5b0ce63-image (1).png
│ │ ├── 5b0ce63-image.png
│ │ ├── 630b5e9-image.png
│ │ ├── 8bf8a6e-Frame_201.png
│ │ ├── 9efd67c-image.png
│ │ ├── aa37226-image.png
│ │ ├── Access (1) (1).png
│ │ ├── Access (1).png
│ │ ├── Access (2).png
│ │ ├── Access.png
│ │ ├── Adding features to a feature view-min.png
│ │ ├── Adopted-min.png
│ │ ├── Adoption strategy V2-min.png
│ │ ├── Adoption strategy-min.png
│ │ ├── Advanced targeting rules V2-min.png
│ │ ├── Advanced targeting rules v3-min.png
│ │ ├── Advanced targeting rules-min.png
│ │ ├── aecc6f2-image.png
│ │ ├── amplitude.svg
│ │ ├── An example targeting configuration with two rules.-min.png
│ │ ├── api.svg
│ │ ├── App Settings-min.png
│ │ ├── Automated feedback surveys settings v3-min.png
│ │ ├── Automated feedback surveys settings-min.png
│ │ ├── Automated feedback surveys-min.png
│ │ ├── aws-s3.svg
│ │ ├── be124cd-dwdwFrame_201 (1).png
│ │ ├── be124cd-dwdwFrame_201.png
│ │ ├── ccc4f9e-image.png
│ │ ├── CleanShot 2024-06-11 at 8 [email protected]
│ │ ├── CleanShot 2024-11-22 at 8 [email protected]
│ │ ├── CleanShot 2024-11-22 at 8 [email protected]
│ │ ├── CleanShot 2024-11-25 at 9 [email protected]
│ │ ├── CleanShot 2024-11-25 at 9 [email protected]
│ │ ├── CleanShot 2024-11-25 at 9 [email protected]
│ │ ├── CleanShot 2024-11-27 at 10 [email protected]
│ │ ├── CleanShot 2024-11-27 at 10 [email protected]
│ │ ├── CleanShot 2024-11-27 at 10 [email protected]
│ │ ├── CleanShot 2024-11-27 at 10 [email protected]
│ │ ├── CleanShot 2025-01-07 at 1 [email protected]
│ │ ├── CleanShot 2025-01-07 at 1 [email protected]
│ │ ├── CleanShot 2025-01-07 at 1 [email protected]
│ │ ├── CleanShot 2025-01-07 at 12 [email protected]
│ │ ├── CleanShot 2025-01-07 at 12 .39.12@2x (1).png
│ │ ├── CleanShot 2025-01-07 at 12 [email protected]
│ │ ├── CleanShot 2025-01-09 at 10 [email protected]
│ │ ├── CleanShot 2025-01-09 at 11 .11.54@2x (1).png
│ │ ├── CleanShot 2025-01-09 at 11 [email protected]
│ │ ├── CleanShot 2025-01-09 at 9 [email protected]
│ │ ├── CleanShot 2025-01-23 at 1 [email protected]
│ │ ├── CleanShot 2025-01-23 at 1 [email protected]
│ │ ├── CleanShot 2025-01-23 at 1 [email protected]
│ │ ├── CleanShot 2025-01-23 at 2 [email protected]
│ │ ├── CleanShot 2025-05-09 at 1 [email protected]
│ │ ├── CleanShot 2025-10-09 at 10 [email protected]
│ │ ├── Companies Tab-min.png
│ │ ├── Companies-min.png
│ │ ├── company example v2-min (1).png
│ │ ├── company example v2-min.png
│ │ ├── company example v3-min.png
│ │ ├── Company segment filters-min.png
│ │ ├── Create a new environment-min.png
│ │ ├── Creating and managing apps-min.png
│ │ ├── cursor-mcp-demo_h264.mp4
│ │ ├── datadog.svg
│ │ ├── Debugger-min (1).png
│ │ ├── Debugger-min (2).png
│ │ ├── Debugger-min.png
│ │ ├── Enabling Feedback Surveys-min.png
│ │ ├── Environments Page V2-min.png
│ │ ├── Environments Switcher-min.png
│ │ ├── Environments-min.png
│ │ ├── Evaluate Feature.png
│ │ ├── example 1 (1).png
│ │ ├── example 1.png
│ │ ├── example 2 (1).png
│ │ ├── example 2.png
│ │ ├── ezgif-242d06617aea38.gif
│ │ ├── Feature Tab-min.png
│ │ ├── Feature targeting rules example v2-min.png
│ │ ├── Feature targeting rules example V2-min.png
│ │ ├── Feature targeting rules example v3-min.png
│ │ ├── Feature targeting rules example-min.png
│ │ ├── Feature targeting rules UI V2-min.png
│ │ ├── Feature targeting rules UI v3-min.png
│ │ ├── Feature targeting rules UI-min.png
│ │ ├── Feature usage configuration-v2-min.png
│ │ ├── Feature view.png
│ │ ├── feature-flag-list-rum-event.d9c1c876a34458edc70d1317efaec05b.png.avif
│ │ ├── Feature-targeting-rules-v2-min.png
│ │ ├── Features Page V2-min (1).png
│ │ ├── Features Page V2-min.png
│ │ ├── Features Page-min.png
│ │ ├── Features-min.png
│ │ ├── Feedback Tab V2-min.png
│ │ ├── Feedback-min.png
│ │ ├── Getting started-min.png
│ │ ├── gitbook-logo.svg
│ │ ├── github-logo.svg
│ │ ├── Global settings - Feature views-min.png
│ │ ├── Global settings - Manual Targeting-min.png
│ │ ├── Global settings - Release Stages Editing V4-min.png
│ │ ├── Global settings - Release Stages-min.png
│ │ ├── Goal Form.png
│ │ ├── How to use release stages v2-min.png
│ │ ├── How to use release stages-min (1).png
│ │ ├── How to use release stages-min.png
│ │ ├── https___content.gitbook.com_content_pgXAy2Cgsm5pON9oJ06m_blobs_6wGbrQlJPE4JllBuIhla_image (1).png
│ │ ├── image (1) (1).png
│ │ ├── image (1) (2).png
│ │ ├── image (1).png
│ │ ├── image (10).png
│ │ ├── image (11).png
│ │ ├── image (12).png
│ │ ├── image (13).png
│ │ ├── image (14).png
│ │ ├── image (15).png
│ │ ├── image (16).png
│ │ ├── image (17).png
│ │ ├── image (18).png
│ │ ├── image (19).png
│ │ ├── image (2) (1).png
│ │ ├── image (2).png
│ │ ├── image (20).png
│ │ ├── image (21).png
│ │ ├── image (22).png
│ │ ├── image (23).png
│ │ ├── image (24).png
│ │ ├── image (25).png
│ │ ├── image (26).png
│ │ ├── image (27).png
│ │ ├── image (28).png
│ │ ├── image (29).png
│ │ ├── image (3).png
│ │ ├── image (30).png
│ │ ├── image (31).png
│ │ ├── image (32).png
│ │ ├── image (33).png
│ │ ├── image (4).png
│ │ ├── image (5).png
│ │ ├── image (6).png
│ │ ├── image (7).png
│ │ ├── image (8).png
│ │ ├── image (9).png
│ │ ├── image.png
│ │ ├── Iterate Feature V2.png
│ │ ├── LInear mention.mp4
│ │ ├── linear.svg
│ │ ├── mcp-remote-min.mp4
│ │ ├── mcp-remote.mp4
│ │ ├── mixpanel.svg
│ │ ├── Modifying or deleting an app-min.png
│ │ ├── Monitor (1) (1).png
│ │ ├── Monitor (1).png
│ │ ├── Monitor (2).png
│ │ ├── Monitor (3).png
│ │ ├── Monitor (4).png
│ │ ├── Monitor (5).png
│ │ ├── Monitor (6).png
│ │ ├── Monitor (7).png
│ │ ├── Monitor.png
│ │ ├── New feature.png
│ │ ├── next-js.svg
│ │ ├── node-js.svg
│ │ ├── openfeature.svg
│ │ ├── posthog.svg
│ │ ├── Pre-Release.png
│ │ ├── react.svg
│ │ ├── Release Goals.png
│ │ ├── Release Stage Beta Targeting Rules v3-min.png
│ │ ├── Release Stage Beta Targeting Rules V3-min.png
│ │ ├── Release Stage Beta Targeting Rules V5-min.png
│ │ ├── Release Stage Beta Targeting Rules-min.png
│ │ ├── remote config - 3.png
│ │ ├── Remote config.png
│ │ ├── Rolling back flags-V2.png
│ │ ├── Rules in other environments.png
│ │ ├── rum-explorer-error-feature-flag-search.7b9f6c046db1de1c71d279c139f1508a.png.avif
│ │ ├── rum-explorer-session-feature-flag-search.435802460fd607608ad5155f029da57b.png.avif
│ │ ├── Satisfaction feedback-min.png
│ │ ├── Satisified-min.png
│ │ ├── Save the segment-min.png
│ │ ├── Saving New Segment-min.png
│ │ ├── Screenshot 2024-08-14 at 19.25.06 (1).png
│ │ ├── Screenshot 2024-08-14 at 19.25.06.png
│ │ ├── Screenshot 2024-08-15 at 13.57.46.png
│ │ ├── Screenshot 2024-10-10 at 14.04.09.png
│ │ ├── Screenshot 2024-10-10 at 14.04.34.png
│ │ ├── Screenshot 2025-07-10 at 14.04.07.png
│ │ ├── Screenshot 2025-07-10 at 14.11.01.png
│ │ ├── Screenshot 2025-07-10 at 14.29.20.png
│ │ ├── Screenshot 2025-07-15 at 21.31.16.png
│ │ ├── Screenshot 2025-07-21 at 20.07.27.png
│ │ ├── Screenshot 2025-09-02 at 17.08.25.png
│ │ ├── Screenshot 2025-09-02 at 17.10.36 (1).png
│ │ ├── Screenshot 2025-09-02 at 17.10.36 (2).png
│ │ ├── Screenshot 2025-09-02 at 17.10.36.png
│ │ ├── Screenshot 2025-09-02 at 17.11.21 (1).png
│ │ ├── Screenshot 2025-09-02 at 17.11.21.png
│ │ ├── Screenshot 2025-09-02 at 17.13.15 (1).png
│ │ ├── Screenshot 2025-09-02 at 17.13.15.png
│ │ ├── Screenshot 2025-09-02 at 17.19.44 (1).png
│ │ ├── Screenshot 2025-09-02 at 17.19.44.png
│ │ ├── Screenshot 2025-09-09 at 09.32.31.png
│ │ ├── Screenshot 2025-09-12 at 11.50.41.png
│ │ ├── Screenshot 2025-09-12 at 12.30.38.png
│ │ ├── Screenshot 2025-09-12 at 13.14.44.png
│ │ ├── Screenshot 2025-09-12 at 13.18.07.png
│ │ ├── Screenshot 2025-09-12 at 13.21.25.png
│ │ ├── Screenshot 2025-09-12 at 13.25.21.png
│ │ ├── Screenshot 2025-09-12 at 14.29.56.png
│ │ ├── Screenshot 2025-09-12 at 14.37.52.png
│ │ ├── Screenshot 2025-09-12 at 14.58.27.png
│ │ ├── Screenshot 2025-09-12 at 15.00.32.png
│ │ ├── Screenshot 2025-09-12 at 15.01.32.png
│ │ ├── Screenshot 2025-09-12 at 15.03.33.png
│ │ ├── Screenshot 2025-09-12 at 15.04.39.png
│ │ ├── Screenshot 2025-09-12 at 15.06.50.png
│ │ ├── Screenshot 2025-09-12 at 15.13.45.png
│ │ ├── Screenshot 2025-09-12 at 15.14.43.png
│ │ ├── Screenshot 2025-09-12 at 15.16.42.png
│ │ ├── Screenshot 2025-09-12 at 15.18.42.png
│ │ ├── Screenshot 2025-09-12 at 15.32.39.png
│ │ ├── Screenshot 2025-09-12 at 15.33.57.png
│ │ ├── Screenshot 2025-09-12 at 15.35.09.png
│ │ ├── Screenshot 2025-09-12 at 15.36.14.png
│ │ ├── segment (1).svg
│ │ ├── segment.svg
│ │ ├── Segments.png
│ │ ├── Set segment conditions-min.png
│ │ ├── Setting multiple targeting rules.png
│ │ ├── Setting Tab-min.png
│ │ ├── Setting targeting rules v3-min.png
│ │ ├── Setting targeting rules-min.png
│ │ ├── Settings-min (1).png
│ │ ├── Settings-min.png
│ │ ├── slack (1).svg
│ │ ├── Slack (with auto-layout)-min.png
│ │ ├── Slack and Environments-min.png
│ │ ├── Slack and Feature views-min.png
│ │ ├── Slack Integration.png
│ │ ├── Slack Settings under Features-min.png
│ │ ├── Slack with User Feedback.png
│ │ ├── slack.svg
│ │ ├── slackConnected (1).png
│ │ ├── slackConnected.png
│ │ ├── slackDisconnected (1).png
│ │ ├── slackDisconnected.png
│ │ ├── STARS Configuration-min.png
│ │ ├── STARS Feature Funnel-min.png
│ │ ├── STARS Feature Report-min.png
│ │ ├── STARS states.png
│ │ ├── surveys-min.png
│ │ ├── Switching Between Environments-min.png
│ │ ├── Targeting rules interface-min.png
│ │ ├── Targeting rules.png
│ │ ├── There are 5 different types of conditions to chose from-min.png
│ │ ├── Track adoption in the UI V2-min.png
│ │ ├── Track adoption in the UI v3-min.png
│ │ ├── Track adoption in the UI-min.png
│ │ ├── Track new feature V2-min.png
│ │ ├── Tracking Tab-min.png
│ │ ├── ts-js.svg
│ │ ├── type-check-failed.png
│ │ ├── type-check-payload-failed.png
│ │ ├── usage attribute example v3.png
│ │ ├── usage attribute example-min.png
│ │ ├── Usage configuration-min.png
│ │ ├── vercel-logo.svg
│ │ ├── vue-logo.svg
│ │ ├── What is the STARS Framework v3-min.png
│ │ └── What is the STARS Framework_-min.png
│ └── includes
│ ├── integrations.md
│ ├── languages.md
│ ├── need-some-help-chat-with-us.md
│ ├── sdks.md
│ └── untitled.md
├── .github
│ └── README.md
├── .vscode
│ └── settings.json
├── api
│ ├── api-access.md
│ ├── cli.md
│ ├── mcp.md
│ ├── public-api
│ │ ├── public-api-reference.md
│ │ └── README.md
│ └── reflag-rest-api
│ ├── README.md
│ └── reflag-api-reference.md
├── guides
│ ├── self-opt-in.md
│ └── use-reflag-in-your-cli.md
├── integrations
│ ├── amplitude.md
│ ├── aws-s3.md
│ ├── cursor.md
│ ├── datadog.md
│ ├── github.md
│ ├── linear.md
│ ├── mixpanel.md
│ ├── overview.md
│ ├── posthog.md
│ ├── segment.md
│ └── slack.md
├── introduction
│ └── concepts
│ ├── app.md
│ ├── company.md
│ ├── environment.md
│ ├── event.md
│ ├── feature-events.md
│ ├── feature-view.md
│ ├── feature.md
│ ├── feedback.md
│ ├── filter.md
│ ├── README.md
│ ├── release-stage.md
│ ├── segment.md
│ ├── targeting-rules.md
│ └── user.md
├── product-handbook
│ ├── anonymous-users.md
│ ├── concepts
│ │ ├── app.md
│ │ ├── company.md
│ │ ├── environment.md
│ │ ├── event.md
│ │ ├── feature-events.md
│ │ ├── feature-view.md
│ │ ├── feature.md
│ │ ├── feedback.md
│ │ ├── filter.md
│ │ ├── README.md
│ │ ├── release-stage.md
│ │ ├── segment.md
│ │ ├── targeting-rules.md
│ │ └── user.md
│ ├── creating-and-managing-apps
│ │ ├── environments.md
│ │ └── README.md
│ ├── creating-and-managing-apps.md
│ ├── creating-segments.md
│ ├── data-export.md
│ ├── data-residency.md
│ ├── feature-clean-up-and-archival-beta
│ │ ├── ai-code-clean-up-beta.md
│ │ └── README.md
│ ├── feature-entitlements
│ │ ├── README.md
│ │ └── simple-role-based-entitlements.md
│ ├── feature-rollouts
│ │ ├── feature-targeting-rules.md
│ │ └── README.md
│ ├── feature-targeting-rules
│ │ ├── creating-segments.md
│ │ └── environments.md
│ ├── feature-views.md
│ ├── launch-monitor
│ │ ├── automated-feedback-surveys.md
│ │ ├── give-feedback-button.md
│ │ └── README.md
│ ├── product-overview.md
│ ├── remote-config.md
│ ├── self-opt-in.md
│ ├── service-resiliency.md
│ ├── team-permissions.md
│ └── type-safety.md
├── README.md
├── sdk
│ ├── _media
│ │ ├── type-check-failed.png
│ │ └── type-check-payload-failed.png
│ ├── @reflag
│ │ ├── browser-sdk
│ │ │ ├── globals.md
│ │ │ └── README.md
│ │ ├── node-sdk
│ │ │ ├── globals.md
│ │ │ └── README.md
│ │ ├── react-sdk
│ │ │ ├── globals.md
│ │ │ └── README.md
│ │ └── vue-sdk
│ │ ├── globals.md
│ │ └── README.md
│ ├── documents
│ │ ├── browser-sdk
│ │ │ └── FEEDBACK.md
│ │ └── cli
│ │ └── README.md
│ └── README.md
├── SUMMARY.md
├── support
│ └── get-support.md
└── supported-languages
├── next.js.md
├── openfeature.md
├── overview.md
└── ruby-rails-stimulus.md
```
# Files
--------------------------------------------------------------------------------
/.gitbook/assets/datadog.svg:
--------------------------------------------------------------------------------
```
1 | <svg width="512" height="289" viewBox="0 0 512 289" fill="none" xmlns="http://www.w3.org/2000/svg">
2 | <style>
3 | @media (prefers-color-scheme: dark) {
4 | path { fill: white; }
5 | }
6 | </style>
7 | <path fill-rule="evenodd" clip-rule="evenodd" d="M191.438 163.833H174.114V124.171H191.438C203.917 124.171 210.165 130.422 210.165 142.92C210.161 156.859 203.917 163.833 191.438 163.833ZM181.516 157.449H190.317C198.608 157.449 202.749 152.607 202.749 142.915C202.749 134.665 198.604 130.537 190.317 130.537H181.516V157.449Z" fill="#632CA6"/>
8 | <path fill-rule="evenodd" clip-rule="evenodd" d="M217.919 163.833H210.314L227.281 124.171H235.244L252.572 163.833H244.61L239.579 153.017H226.781L229.324 146.637H237.624L231.084 131.74L217.919 163.833Z" fill="#632CA6"/>
9 | <path fill-rule="evenodd" clip-rule="evenodd" d="M248.389 124.171H278.711V130.547H267.256V163.833H259.854V130.547H248.389V124.171Z" fill="#632CA6"/>
10 | <path fill-rule="evenodd" clip-rule="evenodd" d="M282.519 163.833H274.913L291.88 124.171H299.843L317.172 163.833H309.2L304.169 153.017H291.371L293.914 146.637H302.215L295.679 131.74L282.519 163.833Z" fill="#632CA6"/>
11 | <path fill-rule="evenodd" clip-rule="evenodd" d="M339.41 163.833H322.086V124.171H339.41C351.898 124.171 358.138 130.422 358.138 142.92C358.138 156.859 351.898 163.833 339.41 163.833ZM329.493 157.449H338.294C346.581 157.449 350.736 152.607 350.736 142.915C350.736 134.665 346.585 130.537 338.294 130.537H329.493V157.449Z" fill="#632CA6"/>
12 | <path fill-rule="evenodd" clip-rule="evenodd" d="M363.154 144.058C363.154 130.607 369.848 123.886 383.225 123.886C396.399 123.886 402.977 130.607 402.977 144.058C402.977 157.43 396.394 164.119 383.225 164.119C370.441 164.119 363.752 157.43 363.154 144.058ZM383.225 157.725C391.267 157.725 395.292 153.114 395.292 143.883C395.292 134.798 391.267 130.252 383.225 130.252C374.971 130.252 370.844 134.798 370.844 143.883C370.844 153.114 374.971 157.725 383.225 157.725Z" fill="#632CA6"/>
13 | <path fill-rule="evenodd" clip-rule="evenodd" d="M433.877 147.784V157.071C432.168 157.513 430.64 157.734 429.292 157.734C420.236 157.734 415.715 152.971 415.715 143.45C415.715 134.656 420.514 130.266 430.107 130.266C434.114 130.266 437.838 131.007 441.284 132.486V125.825C437.838 124.535 433.924 123.886 429.546 123.886C415.201 123.886 408.026 130.404 408.026 143.45C408.026 157.223 415.076 164.119 429.181 164.119C434.03 164.119 438.06 163.419 441.284 162.009V141.257H429.324L426.823 147.78L433.877 147.784Z" fill="#632CA6"/>
14 | <path fill-rule="evenodd" clip-rule="evenodd" d="M144.19 163.608L136.376 158.485L129.859 169.311L122.28 167.109L115.606 177.238L115.948 180.426L152.232 173.779L150.124 151.235L144.19 163.608ZM110.353 153.893L116.175 153.096C117.116 153.515 117.773 153.676 118.904 153.962C120.664 154.418 122.697 154.855 125.713 153.344C126.412 152.999 127.876 151.668 128.464 150.912L152.315 146.61L154.747 175.893L113.887 183.218L110.353 153.893ZM154.654 143.339L152.301 143.786L147.78 97.3152L70.7158 106.201L80.2116 182.821L89.2303 181.518C88.5124 180.495 87.3868 179.256 85.4737 177.671C82.8149 175.479 83.7552 171.747 85.3255 169.393C87.396 165.418 98.0823 160.36 97.4755 154.003C97.2578 151.691 96.8872 148.683 94.7286 146.619C94.6499 147.476 94.7935 148.3 94.7935 148.3C94.7935 148.3 93.9088 147.176 93.4641 145.642C93.024 145.053 92.6812 144.868 92.2134 144.081C91.8799 144.988 91.9262 146.043 91.9262 146.043C91.9262 146.043 91.2036 144.339 91.0832 142.901C90.6524 143.546 90.5458 144.767 90.5458 144.767C90.5458 144.767 89.6055 142.081 89.8186 140.635C89.3878 139.377 88.114 136.881 88.4753 131.205C90.8284 132.845 96.0071 132.454 98.0221 129.496C98.6937 128.515 99.1523 125.843 97.6886 120.578C96.7482 117.202 94.4229 112.171 93.515 110.259L93.4085 110.338C93.8856 111.876 94.8722 115.096 95.2521 116.663C96.3962 121.403 96.7019 123.052 96.1646 125.235C95.706 127.133 94.6128 128.377 91.8336 129.768C89.0543 131.164 85.3672 127.769 85.1309 127.585C82.4304 125.447 80.3413 121.955 80.1097 120.26C79.8688 118.404 81.1844 117.289 81.8514 115.774C80.9018 116.045 79.8411 116.524 79.8411 116.524C79.8411 116.524 81.1056 115.221 82.6666 114.097C83.3151 113.673 83.6903 113.401 84.3713 112.839C83.3846 112.825 82.5833 112.848 82.5833 112.848C82.5833 112.848 84.2277 111.964 85.9323 111.324C84.6862 111.268 83.4912 111.314 83.4912 111.314C83.4912 111.314 87.1598 109.684 90.0548 108.486C92.0466 107.675 93.9921 107.915 95.0853 109.486C96.5213 111.545 98.0267 112.664 101.223 113.36C103.187 112.494 103.78 112.051 106.244 111.383C108.412 109.011 110.116 108.702 110.116 108.702C110.116 108.702 109.273 109.472 109.046 110.683C110.279 109.721 111.627 108.914 111.627 108.914C111.627 108.914 111.103 109.555 110.617 110.573L110.728 110.739C112.164 109.882 113.85 109.209 113.85 109.209C113.85 109.209 113.368 109.817 112.803 110.6C113.887 110.591 116.083 110.646 116.93 110.743C121.961 110.854 123.003 105.4 124.935 104.718C127.353 103.861 128.432 103.34 132.55 107.362C136.084 110.817 138.845 116.994 137.474 118.381C136.325 119.528 134.055 117.934 131.545 114.815C130.215 113.166 129.215 111.218 128.742 108.739C128.344 106.648 126.801 105.436 126.801 105.436C126.801 105.436 127.695 107.422 127.695 109.172C127.695 110.131 127.816 113.705 129.358 115.709C129.205 116.004 129.136 117.16 128.965 117.381C127.172 115.225 123.318 113.682 122.693 113.226C124.819 114.958 129.706 118.938 131.582 122.752C133.356 126.359 132.309 129.667 133.208 130.524C133.462 130.768 137.024 135.181 137.71 137.401C138.905 141.266 137.779 145.329 136.218 147.849L131.85 148.526C131.211 148.351 130.78 148.259 130.206 147.932C130.521 147.374 131.151 145.988 131.156 145.702L130.91 145.274C129.548 147.19 127.274 149.051 125.379 150.12C122.901 151.516 120.048 151.299 118.19 150.728C112.914 149.111 107.926 145.564 106.726 144.633C106.726 144.633 106.689 145.375 106.916 145.545C108.245 147.038 111.293 149.737 114.239 151.617L107.963 152.303L110.932 175.285C109.616 175.474 109.412 175.566 107.972 175.769C106.703 171.31 104.275 168.394 101.621 166.699C99.282 165.202 96.0534 164.865 92.9592 165.473L92.76 165.704C94.9093 165.483 97.4477 165.791 100.051 167.431C102.608 169.039 104.669 173.194 105.429 175.695C106.402 178.892 107.073 182.31 104.456 185.935C102.594 188.511 97.1651 189.934 92.7739 186.857C93.9458 188.732 95.53 190.266 97.6608 190.551C100.829 190.98 103.835 190.431 105.901 188.322C107.666 186.516 108.606 182.739 108.356 178.763L111.149 178.362L112.159 185.498L158.425 179.956L154.654 143.339ZM126.505 123.955C126.375 124.25 126.171 124.438 126.477 125.392L126.496 125.447L126.542 125.572L126.667 125.857C127.218 126.972 127.82 128.027 128.826 128.566C129.085 128.524 129.358 128.492 129.636 128.478C130.581 128.437 131.179 128.584 131.559 128.792C131.591 128.603 131.6 128.331 131.577 127.926C131.503 126.511 131.86 124.107 129.127 122.84C128.094 122.365 126.648 122.508 126.167 123.107C126.255 123.116 126.333 123.135 126.394 123.158C127.13 123.407 126.639 123.655 126.505 123.955ZM134.166 137.152C133.81 136.954 132.133 137.033 130.956 137.171C128.714 137.433 126.292 138.207 125.759 138.617C124.796 139.359 125.231 140.653 125.944 141.183C127.945 142.666 129.696 143.666 131.545 143.422C132.679 143.274 133.68 141.487 134.389 139.861C134.88 138.746 134.88 137.544 134.166 137.152ZM114.309 125.705C114.943 125.106 111.159 124.323 108.222 126.313C106.059 127.783 105.989 130.934 108.06 132.716C108.268 132.891 108.44 133.02 108.597 133.122C109.204 132.836 109.894 132.55 110.686 132.297C112.03 131.864 113.141 131.638 114.058 131.523C114.498 131.035 115.008 130.178 114.878 128.626C114.707 126.511 113.1 126.848 114.309 125.705Z" fill="#632CA6"/>
15 | </svg>
16 |
```
--------------------------------------------------------------------------------
/api/public-api/public-api-reference.md:
--------------------------------------------------------------------------------
```markdown
1 | # Public API Reference
2 |
3 | {% openapi-operation spec="front-api" path="/features/enabled" method="get" %}
4 | [OpenAPI front-api](https://front.reflag.com/openapi.yaml)
5 | {% endopenapi-operation %}
6 |
7 | {% openapi-operation spec="front-api" path="/features" method="get" %}
8 | [OpenAPI front-api](https://front.reflag.com/openapi.yaml)
9 | {% endopenapi-operation %}
10 |
11 | {% openapi-operation spec="front-api" path="/features/evaluated" method="get" %}
12 | [OpenAPI front-api](https://front.reflag.com/openapi.yaml)
13 | {% endopenapi-operation %}
14 |
15 | {% openapi-operation spec="front-api" path="/features/events" method="post" %}
16 | [OpenAPI front-api](https://front.reflag.com/openapi.yaml)
17 | {% endopenapi-operation %}
18 |
19 | {% openapi-operation spec="front-api" path="/user" method="post" %}
20 | [OpenAPI front-api](https://front.reflag.com/openapi.yaml)
21 | {% endopenapi-operation %}
22 |
23 | {% openapi-operation spec="front-api" path="/company" method="post" %}
24 | [OpenAPI front-api](https://front.reflag.com/openapi.yaml)
25 | {% endopenapi-operation %}
26 |
27 | {% openapi-operation spec="front-api" path="/event" method="post" %}
28 | [OpenAPI front-api](https://front.reflag.com/openapi.yaml)
29 | {% endopenapi-operation %}
30 |
31 | {% openapi-operation spec="front-api" path="/feedback" method="post" %}
32 | [OpenAPI front-api](https://front.reflag.com/openapi.yaml)
33 | {% endopenapi-operation %}
34 |
35 | {% openapi-operation spec="front-api" path="/bulk" method="post" %}
36 | [OpenAPI front-api](https://front.reflag.com/openapi.yaml)
37 | {% endopenapi-operation %}
38 |
39 | #### Rules schema
40 |
41 | | Attribute | Type | Description |
42 | | --------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
43 | | filter | Filter | Object containing filtering rules which will evaluate against context object. Filter can be an instance of 5 different filter types described below. |
44 |
45 | #### Filter Schema
46 |
47 | {% tabs %}
48 | {% tab title="Group" %}
49 | | Attribute | Type | Desription |
50 | | --------- | ----------------- | ------------------------------------------------------------------------------------------- |
51 | | type | `group` | Filter group will evaluate by applying a logical operation to the array of filters provided |
52 | | filters | Filter\[] | Array of filters |
53 | | operator | enum(`and`, `or`) | Logical operation |
54 | {% endtab %}
55 |
56 | {% tab title="Negation" %}
57 | | Attribute | Type | Desription |
58 | | --------- | ---------- | ---------------------------------------------------------------------------------- |
59 | | type | `negation` | Negation filter is used to negate the evaluation result of the underlying filters. |
60 | | filter | Filter | Filter object to be negated |
61 | {% endtab %}
62 |
63 | {% tab title="Context" %}
64 | | Attribute | Type | Desription |
65 | | --------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
66 | | type | `context` | |
67 | | field | string | <p>Refers to a field of the context object.<br>Example: company.tier</p> |
68 | | values | string\[] | Array of values which will be compared with the value of the context field. Operators SET, NOT\_SET, IS\_TRUE, IS\_FALSE require 0 values, ANY\_OF and NOT\_ANY\_OF support multiple values. All the other operators require exactly one value. |
69 | | operator | enum(`IS`,`IS_NOT`,`ANY_OF`,`NOT_ANY_OF`,`CONTAINS`,`NOT_CONTAINS`","`GT`" ,`LT`,`AFTER`,`BEFORE`,`SET`,`NOT_SET`,`IS_TRUE`,`IS_FALSE`) | Operator for comparison of the context field with provided values. |
70 | {% endtab %}
71 |
72 | {% tab title="Rollout Percentage" %}
73 | | Attribute | Type | Desription |
74 | | ----------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
75 | | type | `rolloutPercentage` | Rollout percentage filter is used for gradual rollouts. It evaluates to true or false proportionally based on the rollout threshold provided. Reflag evaluates the filter by calculating a numeric hash from the rollout attribute. Contexts of which hash is under the threshold provided will evaluate to true. |
76 | | partialRolloutAttribute | `company.id` | Currently only "company.id" is supported. |
77 | | partialRolloutThreshold | number | Number from 0 to 10000 where 0 means no one will have access and 10000 means everyone will have access. |
78 | {% endtab %}
79 |
80 | {% tab title="Constant" %}
81 | | Attribute | Type | Desription |
82 | | --------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------- |
83 | | type | `constant` | Filter constant will evaluate to the value provided. This is expected when the feature is enabled either for everyone or no one. |
84 | | value | boolean | Value to which the filter should evaluate |
85 | {% endtab %}
86 | {% endtabs %}
87 |
```
--------------------------------------------------------------------------------
/product-handbook/launch-monitor/automated-feedback-surveys.md:
--------------------------------------------------------------------------------
```markdown
1 | ---
2 | description: Learn more about automated feedback surveys in Reflag
3 | ---
4 |
5 | # Automated feedback surveys
6 |
7 | Automated feedback surveys are no-code surveys that collect in-app user feedback right after a user interacts with a feature.
8 |
9 | ## Getting started
10 |
11 | * Select the [feature](../concepts/feature.md) that you would like to start collecting feedback for
12 | * Go to `Settings` and click on `Enable Feedback surveys`
13 | * Enter a question in the `Prompt question` input. \
14 | For example: `How did you like the new Huddle feature?`
15 | * Click the `Save` button to save your settings
16 |
17 | <div align="left"><figure><img src="../../.gitbook/assets/surveys-min.png" alt="Automated feedback survey settings"><figcaption></figcaption></figure></div>
18 |
19 | * Test your feedback widget.
20 | * The `Try out` button allows you to test the feedback widget.\
21 | \
22 | Select or search for a specific user you’d like to test it on (generally yourself or another team member) and click `Trigger the prompt`.\
23 | \
24 | Make sure that you’ve enabled feedback surveys and clicked the `Save` button _before_ testing.
25 |
26 | ## Configuration
27 |
28 | * Define the `Prompt question`
29 | * The question specified here will be displayed as a question to the user in the feedback widget.
30 | * Set the `Min. interactions before triggering`
31 | * Defines the number of times a user needs to interact with a feature before the feedback widget is triggered.\
32 | \
33 | This lets you gather feedback from first-time users or users who used the feature multiple times.\
34 | \
35 | The value is in events. The default value is 1.
36 | * Set the `Min. time after interactions` 
37 | * Determines the duration of time before the feedback widget is displayed.\
38 | \
39 | This lets you ask the user for feedback at the most relevant time after their interaction.\
40 | \
41 | The value is in seconds. The default value is 1.
42 | * Set the `Max. time after interactions` 
43 | * Defines the maximum time for the feedback widget to appear to a user after they've interacted with a feature.\
44 | \
45 | The value is in seconds. The default value is 10.
46 |
47 | ### Configure max surveys per user per period
48 |
49 | If you've enabled surveys for multiple features, you don’t want to overload users with them. 
50 |
51 | To configure the maximum number of surveys each user sees during a given period, do the following:
52 |
53 | * On the sidebar, click `Settings`. Then, select `Feedback`.
54 | * Using the `Minimum time between asking for feedback` dropdown, you can define the duration required after a survey appears before a user is asked again. 
55 | * You can choose from 11 pre-defined delay periods ranging from 5 minutes to 3 months.\
56 | \
57 | **Delay operators**
58 | * `5 minutes`
59 | * `20 minutes`
60 | * `1 hour`
61 | * `6 hours`
62 | * `2 days`
63 | * `5 days`
64 | * `1 week`
65 | * `2 weeks`
66 | * `1 month`
67 | * `2 months`
68 | * `3 months`
69 |
70 | The default value is 1 week. 
71 |
72 | Reflag will never ask a user for feedback about the same feature more than once, regardless of the `Minimum time between asking for feedback` configuration.
73 |
74 | ## Default feedback widget behavior
75 |
76 | In the default state, the widget will appear in the bottom right corner of your app.
77 |
78 | 
79 |
80 | Once a user interacts with the widget by providing a CSAT score, the widget will expand to give them the option to add feedback.
81 |
82 | .png>)
83 |
84 | After a user leaves a comment and clicks `Send feedback`, the widget will display a confirmation message and automatically close.
85 |
86 | .png>)
87 |
88 | The feedback widget will automatically close if a user doesn't interact with it.\
89 | \
90 | The remaining time is visualized by the circle around the `x` button. When the circle is empty, the widget will disappear.
91 |
92 | ## Customizing the feedback widget
93 |
94 | The behavior, language, positioning, content, and design of the feedback widget are fully customizable. This lets you integrate the feedback surveys with your app while following existing UI and design guidelines.\
95 | \
96 | You can find the complete developer documentation [on GitHub](https://github.com/reflagcom/javascript/blob/main/packages/browser-sdk/FEEDBACK.md).
97 |
98 | 
99 |
100 | Here's a glimpse of how you can tailor the feedback widget to your needs.
101 |
102 | ### Positioning
103 |
104 | The feedback widget can be configured to be placed and behave in three different ways:
105 |
106 | | Type | Description |
107 | | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
108 | | **Modal** | A modal overlay with a backdrop that blocks interaction with the underlying page. It is always centered on the page, making it the primary interface the user needs to interact with. |
109 | | **Dialog** | A dialog appears in a specified corner of the viewport without limiting interaction with the rest of the page. It can be dismissed with a close button or will automatically disappear after a period if there is no interaction. |
110 | | **Pushover** | A popover is anchored relative to a DOM element (typically a button). It can be dismissed by clicking outside the popover or by pressing the dedicated close button. |
111 |
112 | Find additional positioning details in the [developer documentation](https://github.com/reflagcom/javascript/blob/main/packages/browser-sdk/FEEDBACK.md#positioning-and-behavior). 
113 |
114 | ### Language
115 |
116 | You can customize the language of the feedback widget statically at page load or dynamically during runtime.\
117 | \
118 | You can supply your translations by passing an object to the options to either or both of the `reflag.init(options)` or `reflag.requestFeedback(options)` calls. These translations replace the English ones used by the feedback widget. 
119 |
120 | Find additional details about languages and translation in the [developer documentation](https://github.com/reflagcom/javascript/blob/main/packages/browser-sdk/FEEDBACK.md#internationalization-i18n).
121 |
122 | ### Custom styling
123 |
124 | The styling can be fully customized by applying custom CSS properties to your page in the CSS `:root` scope. 
125 |
126 | More information can be found in the [developer documentation](https://github.com/reflagcom/javascript/blob/main/packages/browser-sdk/FEEDBACK.md#custom-styling) and [example stylesheet](https://github.com/reflagcom/javascript/blob/main/packages/tracking-sdk/dev/index.css).
127 |
128 | ### Using your UI
129 |
130 | You can replace the existing UI with your own and intercept the standard feedback survey event to trigger your own or collect feedback manually and pass it along to Reflag.
131 |
132 | Check out the[ developer documentation](https://github.com/reflagcom/javascript/blob/main/packages/browser-sdk/FEEDBACK.md#using-your-own-ui-to-collect-feedback) for the full rundown.
133 |
134 | ### Overriding global configurations
135 |
136 | The Reflag SDK feedback widget is configured with the following defaults:
137 |
138 | * Positioning: Lower right-hand corner of the viewport
139 | * Language: English
140 | * Theme: Light mode 
141 |
142 | These settings can be overwritten when initializing the Reflag SDK.
143 |
144 | The [developer documentation](https://github.com/reflagcom/javascript/blob/main/packages/browser-sdk/FEEDBACK.md#global-feedback-configuration) explains how. 
145 |
146 | ## Technical overview
147 |
148 | When the [Reflag Browser SDK](https://github.com/reflagcom/javascript) is installed in your web application, browsers using your application will automatically open and maintain a connection to Reflag’s servers through a real-time server-sent events connection.
149 |
150 | This allows the installed SDK to react to any events that are sent to Reflag, even events you send through other means, for example, from your servers. 
151 |
152 | When a user triggers an event tracked by a feature, Reflag may determine the `Min. interactions before triggering` event threshold has been surpassed and prompt the user for feedback. If so, the Reflag service will send a request to the SDK instance. 
153 |
154 | By default, this request will open up the Reflag feedback widget in the user's browser through the real-time connection.
155 |
156 | The live connection for automated feedback is established once you have initialized the ReflagClient
157 |
```
--------------------------------------------------------------------------------
/.gitbook/assets/node-js.svg:
--------------------------------------------------------------------------------
```
1 | <svg width="512" height="290" viewBox="0 0 512 290" fill="none" xmlns="http://www.w3.org/2000/svg">
2 | <style>
3 | @media (prefers-color-scheme: dark) {
4 | path { fill: white; }
5 | }
6 | </style>
7 | <path d="M374.467 190.537C373.657 190.537 372.902 190.319 372.201 189.938L365.025 185.64C363.946 185.041 364.486 184.824 364.81 184.715C366.266 184.225 366.535 184.116 368.046 183.246C368.208 183.137 368.424 183.191 368.586 183.3L374.088 186.619C374.304 186.728 374.574 186.728 374.735 186.619L396.262 174.05C396.477 173.941 396.587 173.724 396.587 173.452V148.368C396.587 148.096 396.477 147.879 396.262 147.77L374.735 135.255C374.52 135.146 374.25 135.146 374.088 135.255L352.563 147.77C352.347 147.879 352.239 148.151 352.239 148.368V173.452C352.239 173.669 352.347 173.941 352.563 174.05L358.443 177.478C361.626 179.11 363.622 177.206 363.622 175.302V150.545C363.622 150.218 363.892 149.892 364.27 149.892H367.022C367.345 149.892 367.669 150.164 367.669 150.545V175.302C367.669 179.6 365.349 182.103 361.302 182.103C360.062 182.103 359.091 182.103 356.339 180.743L350.674 177.478C349.272 176.662 348.408 175.139 348.408 173.506V148.423C348.408 146.79 349.272 145.267 350.674 144.451L372.201 131.882C373.549 131.12 375.384 131.12 376.732 131.882L398.258 144.451C399.66 145.267 400.523 146.79 400.523 148.423V173.506C400.523 175.139 399.66 176.662 398.258 177.478L376.732 190.047C376.085 190.319 375.276 190.537 374.467 190.537Z" fill="#5FA04E"/>
8 | <path d="M381.157 173.288C371.714 173.288 369.772 168.935 369.772 165.235C369.772 164.909 370.042 164.582 370.419 164.582H373.224C373.549 164.582 373.819 164.8 373.819 165.126C374.25 168.01 375.49 169.425 381.21 169.425C385.742 169.425 387.684 168.391 387.684 165.943C387.684 164.528 387.143 163.494 380.076 162.787C374.196 162.188 370.527 160.882 370.527 156.149C370.527 151.741 374.196 149.13 380.346 149.13C387.253 149.13 390.652 151.524 391.083 156.747C391.083 156.911 391.029 157.074 390.922 157.237C390.812 157.346 390.652 157.455 390.487 157.455H387.628C387.361 157.455 387.09 157.237 387.036 156.965C386.388 153.972 384.715 152.993 380.292 152.993C375.329 152.993 374.735 154.734 374.735 156.04C374.735 157.618 375.436 158.107 382.127 158.978C388.762 159.848 391.892 161.1 391.892 165.779C391.892 170.567 387.953 173.288 381.157 173.288Z" fill="#5FA04E"/>
9 | <path d="M412.234 146.953C412.234 149.238 410.345 151.143 408.077 151.143C405.813 151.143 403.924 149.293 403.924 146.953C403.924 144.559 405.867 142.764 408.077 142.764C410.291 142.764 412.234 144.613 412.234 146.953ZM404.572 146.953C404.572 148.912 406.137 150.49 408.024 150.49C409.967 150.49 411.532 148.857 411.532 146.953C411.532 144.994 409.967 143.471 408.024 143.471C406.191 143.471 404.572 144.994 404.572 146.953ZM406.515 144.613H408.134C408.673 144.613 409.753 144.613 409.753 145.865C409.753 146.735 409.211 146.899 408.886 147.007C409.536 147.062 409.589 147.497 409.643 148.096C409.696 148.477 409.753 149.13 409.859 149.347H408.886C408.886 149.13 408.726 147.933 408.726 147.878C408.673 147.606 408.565 147.497 408.242 147.497H407.432V149.401H406.515V144.613ZM407.378 146.681H408.077C408.673 146.681 408.78 146.246 408.78 146.028C408.78 145.375 408.348 145.375 408.077 145.375H407.325V146.681H407.378Z" fill="#5FA04E"/>
10 | <path fill-rule="evenodd" clip-rule="evenodd" d="M150.198 147.296C150.198 146.316 149.659 145.392 148.795 144.902L125.975 131.571C125.597 131.354 125.166 131.245 124.734 131.19C124.68 131.19 124.518 131.19 124.518 131.19C124.087 131.19 123.655 131.354 123.277 131.571L100.403 144.847C99.5395 145.337 99 146.262 99 147.296L99.0539 182.99C99.0539 183.479 99.3237 183.969 99.7553 184.186C100.187 184.459 100.726 184.459 101.104 184.186L114.699 176.351C115.563 175.862 116.102 174.937 116.102 173.957V157.253C116.102 156.274 116.641 155.349 117.505 154.859L123.277 151.486C123.709 151.213 124.194 151.105 124.68 151.105C125.166 151.105 125.651 151.213 126.029 151.486L131.801 154.859C132.664 155.349 133.204 156.274 133.204 157.253V173.957C133.204 174.937 133.744 175.862 134.607 176.351L148.094 184.186C148.526 184.459 149.065 184.459 149.497 184.186C149.928 183.969 150.198 183.479 150.198 182.99V147.296Z" fill="#333333"/>
11 | <path fill-rule="evenodd" clip-rule="evenodd" d="M260.148 98.1632C259.716 97.9456 259.176 97.9456 258.799 98.1632C258.367 98.4353 258.098 98.8706 258.098 99.3603V134.727C258.098 135.054 257.936 135.38 257.611 135.598C257.288 135.761 256.964 135.761 256.641 135.598L250.922 132.279C250.059 131.789 249.034 131.789 248.171 132.279L225.296 145.61C224.433 146.099 223.894 147.024 223.894 148.004V174.61C223.894 175.59 224.433 176.515 225.296 177.005L248.171 190.335C249.034 190.825 250.059 190.825 250.922 190.335L273.797 177.005C274.66 176.515 275.199 175.59 275.199 174.61V108.284C275.199 107.25 274.66 106.325 273.797 105.835L260.148 98.1632ZM258.044 165.85C258.044 166.122 257.936 166.34 257.72 166.449L249.896 171.02C249.681 171.128 249.411 171.128 249.195 171.02L241.373 166.449C241.157 166.34 241.049 166.068 241.049 165.85V156.71C241.049 156.437 241.157 156.22 241.373 156.111L249.195 151.54C249.411 151.432 249.681 151.432 249.896 151.54L257.72 156.111C257.936 156.22 258.044 156.492 258.044 156.71V165.85Z" fill="#333333"/>
12 | <path fill-rule="evenodd" clip-rule="evenodd" d="M336.268 156.492C337.132 156.002 337.617 155.077 337.617 154.097V147.622C337.617 146.643 337.078 145.718 336.268 145.229L313.555 131.952C312.692 131.463 311.668 131.463 310.804 131.952L287.93 145.283C287.066 145.773 286.527 146.698 286.527 147.677V174.284C286.527 175.263 287.066 176.188 287.93 176.678L310.642 189.737C311.506 190.226 312.53 190.226 313.339 189.737L327.097 182.01C327.529 181.793 327.798 181.303 327.798 180.813C327.798 180.324 327.529 179.834 327.097 179.616L304.115 166.285C303.683 166.014 303.414 165.578 303.414 165.089V156.764C303.414 156.274 303.683 155.784 304.115 155.567L311.29 151.431C311.722 151.159 312.261 151.159 312.692 151.431L319.868 155.567C320.299 155.839 320.569 156.274 320.569 156.764V163.293C320.569 163.783 320.838 164.272 321.271 164.49C321.702 164.762 322.242 164.762 322.673 164.49L336.268 156.492Z" fill="#333333"/>
13 | <path fill-rule="evenodd" clip-rule="evenodd" d="M311.829 155.241C311.991 155.132 312.208 155.132 312.37 155.241L316.739 157.798C316.901 157.907 317.009 158.07 317.009 158.288V163.402C317.009 163.62 316.901 163.783 316.739 163.892L312.37 166.449C312.208 166.558 311.991 166.558 311.829 166.449L307.46 163.892C307.299 163.783 307.191 163.62 307.191 163.402V158.288C307.191 158.07 307.299 157.907 307.46 157.798L311.829 155.241Z" fill="#5FA04E"/>
14 | <path d="M188.447 132.061C187.583 131.572 186.558 131.572 185.695 132.061L162.982 145.283C162.119 145.773 161.634 146.698 161.634 147.677V174.175C161.634 175.155 162.173 176.08 162.982 176.569L185.695 189.791C186.558 190.281 187.583 190.281 188.447 189.791L211.159 176.569C212.023 176.08 212.508 175.155 212.508 174.175V147.677C212.508 146.698 211.969 145.773 211.159 145.283L188.447 132.061Z" fill="url(#paint0_linear_1_258)"/>
15 | <path d="M211.213 145.283L188.393 132.061C188.177 131.952 187.907 131.844 187.691 131.789L162.119 175.916C162.335 176.188 162.605 176.406 162.875 176.569L185.695 189.791C186.343 190.172 187.098 190.281 187.799 190.063L211.807 145.773C211.645 145.555 211.429 145.392 211.213 145.283Z" fill="url(#paint1_linear_1_258)"/>
16 | <path d="M211.214 176.569C211.861 176.188 212.347 175.535 212.563 174.827L187.584 131.734C186.937 131.625 186.235 131.679 185.642 132.06L162.983 145.228L187.422 190.171C187.746 190.117 188.124 190.008 188.447 189.845L211.214 176.569Z" fill="url(#paint2_linear_1_258)"/>
17 | <defs>
18 | <linearGradient id="paint0_linear_1_258" x1="196.321" y1="141.908" x2="175.502" y2="184.02" gradientUnits="userSpaceOnUse">
19 | <stop stop-color="#3F873F"/>
20 | <stop offset="0.3296" stop-color="#3F8B3D"/>
21 | <stop offset="0.6367" stop-color="#3E9638"/>
22 | <stop offset="0.9341" stop-color="#3DA92E"/>
23 | <stop offset="1" stop-color="#3DAE2B"/>
24 | </linearGradient>
25 | <linearGradient id="paint1_linear_1_258" x1="183.619" y1="164.02" x2="241.587" y2="121.554" gradientUnits="userSpaceOnUse">
26 | <stop offset="0.1376" stop-color="#3F873F"/>
27 | <stop offset="0.4016" stop-color="#52A044"/>
28 | <stop offset="0.7129" stop-color="#64B749"/>
29 | <stop offset="0.9081" stop-color="#6ABF4B"/>
30 | </linearGradient>
31 | <linearGradient id="paint2_linear_1_258" x1="160.802" y1="160.917" x2="213.358" y2="160.917" gradientUnits="userSpaceOnUse">
32 | <stop offset="0.0919165" stop-color="#6ABF4B"/>
33 | <stop offset="0.2871" stop-color="#64B749"/>
34 | <stop offset="0.5984" stop-color="#52A044"/>
35 | <stop offset="0.8624" stop-color="#3F873F"/>
36 | </linearGradient>
37 | </defs>
38 | </svg>
39 |
```
--------------------------------------------------------------------------------
/product-handbook/data-export.md:
--------------------------------------------------------------------------------
```markdown
1 | ---
2 | description: Learn more about data warehouse in Reflag
3 | ---
4 |
5 | # Warehouse
6 |
7 | Reflag allows you to export company adoption data in a CSV file to use in other tools or databases. This can be done either manually or automatically, depending on your plan.
8 |
9 | {% hint style="info" %}
10 | Data exports are only available on Pro and Enterprise plans. Automatic data exports are only available on the Enterprise plan. 
11 | {% endhint %}
12 |
13 | ## Getting started
14 |
15 | * Navigate to `Settings`
16 | * Under `Environment: [Environment Name]`, select `Data export`.  
17 | * Under `Manual export`, select the [historical data aggregation](data-export.md#historical-data) of your choice
18 | * Click the `Download export` button to get your CSV
19 | * If you have access to [automatic exports](data-export.md#automatic-export), turn the `Enable automatic export` toggle to `ON` and follow the instructions below. 
20 |
21 | ## Historical data
22 |
23 | There are 4 historical data aggregation options:
24 |
25 | * **Just today's snapshot**: Download a snapshot of the current state of the data. The `Date` column will contain the current date.
26 | * **30 days, daily granularity**: The file will contain data rolled up in daily increments for the last 30 days. The `Date` column will be the end of each rolled-up day data
27 | * **3 months, weekly granularity**: The file will contain data rolled up in weekly increments for the last 3 months. A weekly increment is a full calendar week (mon-sun). The `Date` column will be the data at the end of each rolled-up interval.
28 | * **6 months, weekly granularity**: The file will contain data rolled up in weekly increments for the last 6 months. A weekly increment is a full calendar week (mon-sun). The `Date` column will be the data at the end of each rolled-up interval.
29 |
30 | ## Automatic export
31 |
32 | {% hint style="info" %}
33 | Read our [AWS S3](../integrations/aws-s3.md) data export guide.
34 | {% endhint %}
35 |
36 | You can also schedule data exports that run on a **daily** or **weekly** cadence. If enabled, Reflag automatically generates and exports a `CSV` file for each day or week and saves it to your S3-compatible file storage provider (such as _AWS S3_, _Google Cloud Storage_, _Cloudflare R2_, and others).
37 |
38 | * **Daily export**: Runs every day after `00:00 UTC` and exports a snapshot of the data as it was at `00:00 UTC`. 
39 | * **Weekly export**: Runs every Monday after `00:00 UTC` and exports a snapshot of the data as it was at `00:00 UTC on Monday`.
40 |
41 | After enabling automatic exports, fill in the required configuration details:
42 |
43 | * **Periodic schedule**: The cadence of data export (either `daily` or `weekly`)
44 | * **S3 Provider**: The S3-compatible cloud storage. Support is available for `AWS`, `GCP` and `Custom` which allows for the specification of a custom Endpoint value (useful for Cloudflare R2)
45 | * **S3 bucket**: The details of the S3 bucket that will be used to store the exported data files
46 | * For `AWS`: Enter the S3 bucket's public URL in the following format: `https://<bucket>.s3.<region>.amazonaws.com[/key]`. The `key` component of the URL is optional. It can be used to point to a specific directory within the bucket. For more details, see the [AWS S3 setup guide](doc:aws-s3-setup-guide).
47 | * For `GCP` and `Custom`: The **Bucket**, **Region**, and **Key** properties need to be inserted separately in each of the input boxes on the `Settings` page.
48 | * For `Custom`: The **Endpoint** option becomes available. It needs to be filled with the URL of the cloud storage provider API. For instance, Cloudflare R2 will provide an individual endpoint value for each of their customers in the following format: `https://<ACCOUNT_ID>.eu.r2.cloudflarestorage.com`.
49 | * **Access key**: The access key obtained from the cloud storage provider
50 | * **Secret access key**: The secret access key is obtained from the cloud storage provider
51 |
52 | After clicking `Save`, Reflag will validate that the supplied details are correct by attempting to list the files in the S3 bucket. 
53 |
54 | If there is an error (such as misconfigured credentials, missing privileges, or misspelled names), an error message will appear. 
55 |
56 | Reflag will run the data export the following day or the next Monday depending on the selected cadence.
57 |
58 | Reflag records the status of the operation and displays it below the toggle. The status will show:
59 |
60 | * When the last export ran
61 | * The status of the last export. One of:
62 | * `never ran before`
63 | * `successful` 
64 | * `failed`
65 | * When the next export will run
66 | * In case of an error, an error message
67 |
68 | ## Company data model
69 |
70 | The company model contains information about company adoption of all your features.
71 |
72 | | Column | Data type | Format | Description |
73 | | ------------------ | ------------------ | ---------------------------------------------------------------- | ----------------------------------------------------------- |
74 | | Company ID | `string` | | Company ID from your tracking calls |
75 | | Company Name | `string` \| `null` | | The company's name, if sent through tracking |
76 | | Feature Name | `string` | | Reflag feature name |
77 | | Feature ID | `string` | | Reflag feature ID |
78 | | Date | `string` | UTC Date (ISO-8601) | The date of data point |
79 | | First Seen | `string` | UTC Date (ISO-8601) | The company's first tracking date |
80 | | Last Seen | `string` | UTC Date (ISO-8601) | The company's latest tracking date |
81 | | First Used | `string` \| `null` | UTC Date (ISO-8601) | Company first feature usage |
82 | | Last Used | `string` \| `null` | UTC Date (ISO-8601) | The company's latest feature usage |
83 | | STARS State Label | `string`\| `null` | One of the:`"never"` \| `"tried"` \| `"retained"` \| `"churned"` | Human readable value for the STARS step |
84 | | STARS State | `number` | One of the: `1` \| `2` \| `3`\| `4` | The company [STARS state](broken-reference) for the feature |
85 | | Frequency Label | `string` | | Human readable label for the frequency value |
86 | | Frequency | `number` | One of: `0` \| `1` \| `2` \| `3` | Company feature usage frequency. Higher means more frequent |
87 | | Satisfaction Label | `string` | | Human readable label for the satisfaction score |
88 | | Satisfaction | `number` \| `null` | One of: `1` \| `2` \| `3` \| `4` \| `5` | Company feature satisfaction score. Higher is better |
89 | | Feedback Count | `number` | | Total number of feedbacks recorded |
90 | | Segment Names | `string` | Comma separated list | List of segment names the company is a part of |
91 | | Segment IDs | `string` | Comma separated list | List of segment id's the company is a part of |
92 |
93 | ## Articles of interest
94 |
95 | * [GCP Hmac keys](https://cloud.google.com/storage/docs/authentication/hmackeys): Obtain Google Storage `Access key` and `Secret access key` pair
96 | * [S3 API](https://developers.cloudflare.com/r2/api/s3/api/): Cloudflare guide for R2
97 | * [Ingest into BigQuery](https://cloud.google.com/bigquery/docs/s3-transfer-intro): A guide on importing data into Google's BigQuery
98 | * [Ingest into Snowflake](https://docs.snowflake.com/en/user-guide/data-load-s3) and [Automatic ingest into Snowflake](https://docs.snowflake.com/en/user-guide/data-load-snowpipe-auto-s3): These guides show you to how to import data into Snowflake.
99 |
```
--------------------------------------------------------------------------------
/.gitbook/assets/react.svg:
--------------------------------------------------------------------------------
```
1 | <svg width="513" height="290" viewBox="0 0 513 290" fill="none" xmlns="http://www.w3.org/2000/svg">
2 | <style>
3 | @media (prefers-color-scheme: dark) {
4 | path { fill: white; }
5 | }
6 | </style>
7 | <path d="M145 154.404C149.838 154.404 153.759 150.417 153.759 145.499C153.759 140.581 149.838 136.595 145 136.595C140.163 136.595 136.241 140.581 136.241 145.499C136.241 150.417 140.163 154.404 145 154.404Z" fill="#61DAFB"/>
8 | <path fill-rule="evenodd" clip-rule="evenodd" d="M103.358 140.274C101.287 142.175 100.484 143.945 100.484 145.501C100.484 147.056 101.287 148.827 103.358 150.728C105.429 152.628 108.565 154.455 112.652 156.042C120.809 159.208 132.245 161.219 145 161.219C157.755 161.219 169.191 159.208 177.348 156.042C181.435 154.455 184.571 152.628 186.642 150.728C188.713 148.827 189.516 147.056 189.516 145.501C189.516 143.945 188.713 142.175 186.642 140.274C184.571 138.373 181.435 136.546 177.348 134.96C169.191 131.794 157.755 129.783 145 129.783C132.245 129.783 120.809 131.794 112.652 134.96C108.565 136.546 105.429 138.373 103.358 140.274ZM110.88 130.242C119.734 126.805 131.798 124.733 145 124.733C158.202 124.733 170.266 126.805 179.12 130.242C183.538 131.957 187.285 134.061 189.971 136.525C192.656 138.99 194.484 142.019 194.484 145.501C194.484 148.983 192.656 152.012 189.971 154.476C187.285 156.941 183.538 159.044 179.12 160.76C170.266 164.196 158.202 166.269 145 166.269C131.798 166.269 119.734 164.196 110.88 160.76C106.462 159.044 102.715 156.941 100.029 154.476C97.3438 152.012 95.5162 148.983 95.5162 145.501C95.5162 142.019 97.3438 138.99 100.029 136.525C102.715 134.061 106.462 131.957 110.88 130.242Z" fill="#61DAFB"/>
9 | <path fill-rule="evenodd" clip-rule="evenodd" d="M128.631 106.225C125.976 105.352 124.066 105.531 122.741 106.308C121.416 107.086 120.309 108.678 119.725 111.452C119.142 114.226 119.153 117.9 119.845 122.292C121.227 131.056 125.231 142.129 131.609 153.359C137.987 164.589 145.418 173.651 152.193 179.249C155.588 182.054 158.713 183.902 161.368 184.775C164.022 185.648 165.932 185.469 167.257 184.692C168.582 183.914 169.689 182.322 170.273 179.548C170.856 176.774 170.845 173.1 170.153 168.708C168.772 159.944 164.767 148.871 158.389 137.641C152.012 126.411 144.58 117.349 137.805 111.751C134.41 108.946 131.285 107.098 128.631 106.225ZM140.938 107.832C148.293 113.908 156.09 123.493 162.691 135.116C169.292 146.739 173.559 158.396 175.058 167.91C175.806 172.657 175.887 177.008 175.131 180.604C174.374 184.201 172.708 187.324 169.741 189.065C166.775 190.806 163.281 190.712 159.838 189.58C156.396 188.447 152.731 186.201 149.06 183.168C141.706 177.092 133.908 167.507 127.307 155.884C120.706 144.261 116.44 132.604 114.94 123.09C114.192 118.343 114.111 113.992 114.868 110.396C115.624 106.799 117.291 103.676 120.257 101.935C123.224 100.194 126.718 100.288 130.16 101.42C133.602 102.552 137.268 104.799 140.938 107.832Z" fill="#61DAFB"/>
10 | <path fill-rule="evenodd" clip-rule="evenodd" d="M170.278 111.451C169.695 108.677 168.588 107.085 167.263 106.308C165.938 105.53 164.028 105.351 161.373 106.224C158.718 107.097 155.594 108.945 152.199 111.75C145.423 117.348 137.992 126.41 131.614 137.64C125.237 148.87 121.232 159.944 119.851 168.708C119.159 173.099 119.147 176.774 119.731 179.547C120.314 182.321 121.421 183.913 122.746 184.691C124.072 185.469 125.981 185.647 128.636 184.774C131.291 183.901 134.416 182.054 137.81 179.249C144.586 173.651 152.017 164.588 158.395 153.358C164.772 142.129 168.777 131.055 170.158 122.291C170.85 117.9 170.862 114.225 170.278 111.451ZM175.063 123.09C173.564 132.603 169.298 144.26 162.697 155.883C156.096 167.506 148.298 177.091 140.943 183.168C137.273 186.2 133.608 188.447 130.165 189.579C126.723 190.711 123.229 190.805 120.263 189.064C117.296 187.323 115.63 184.2 114.873 180.603C114.116 177.007 114.198 172.656 114.946 167.909C116.445 158.395 120.711 146.738 127.312 135.115C133.913 123.492 141.711 113.908 149.066 107.831C152.736 104.798 156.402 102.552 159.844 101.42C163.286 100.288 166.78 100.193 169.746 101.934C172.713 103.675 174.379 106.799 175.136 110.395C175.893 113.992 175.812 118.342 175.063 123.09Z" fill="#61DAFB"/>
11 | <path d="M417.491 174.447C413.517 174.447 410.438 173.379 408.253 171.243C406.067 169.108 404.975 166.053 404.975 162.08V125.873H412.127V161.782C412.127 163.918 412.648 165.557 413.691 166.699C414.784 167.841 416.324 168.412 418.31 168.412C420.545 168.412 422.408 167.792 423.898 166.55L426.133 171.69C425.04 172.634 423.724 173.329 422.184 173.776C420.694 174.223 419.13 174.447 417.491 174.447ZM398.27 140.4V134.515H423.451V140.4H398.27Z" fill="black"/>
12 | <path d="M378.071 174.447C374.048 174.447 370.447 173.578 367.268 171.839C364.139 170.101 361.681 167.717 359.893 164.687C358.105 161.658 357.211 158.181 357.211 154.257C357.211 150.334 358.105 146.857 359.893 143.827C361.681 140.798 364.139 138.439 367.268 136.75C370.447 135.012 374.048 134.142 378.071 134.142C381.647 134.142 384.826 134.863 387.607 136.303C390.438 137.694 392.623 139.78 394.163 142.561L388.724 146.062C387.433 144.125 385.844 142.71 383.956 141.816C382.119 140.872 380.132 140.4 377.996 140.4C375.414 140.4 373.104 140.972 371.068 142.114C369.032 143.256 367.417 144.87 366.225 146.956C365.033 148.993 364.437 151.426 364.437 154.257C364.437 157.088 365.033 159.547 366.225 161.633C367.417 163.719 369.032 165.333 371.068 166.475C373.104 167.618 375.414 168.189 377.996 168.189C380.132 168.189 382.119 167.742 383.956 166.848C385.844 165.904 387.433 164.464 388.724 162.527L394.163 165.954C392.623 168.686 390.438 170.796 387.607 172.286C384.826 173.727 381.647 174.447 378.071 174.447Z" fill="black"/>
13 | <path d="M340.847 174V165.656L340.474 164.091V149.862C340.474 146.832 339.58 144.498 337.792 142.859C336.054 141.17 333.422 140.326 329.895 140.326C327.561 140.326 325.276 140.723 323.041 141.518C320.806 142.263 318.919 143.281 317.379 144.572L314.399 139.208C316.436 137.569 318.869 136.328 321.7 135.483C324.581 134.589 327.586 134.142 330.715 134.142C336.128 134.142 340.3 135.459 343.231 138.091C346.161 140.723 347.626 144.746 347.626 150.16V174H340.847ZM327.884 174.447C324.953 174.447 322.371 173.95 320.136 172.957C317.95 171.964 316.262 170.598 315.07 168.859C313.878 167.071 313.282 165.06 313.282 162.825C313.282 160.689 313.778 158.752 314.772 157.014C315.815 155.276 317.479 153.885 319.763 152.842C322.098 151.799 325.227 151.277 329.15 151.277H341.666V156.418H329.448C325.872 156.418 323.463 157.014 322.222 158.206C320.98 159.398 320.359 160.838 320.359 162.527C320.359 164.464 321.129 166.028 322.669 167.22C324.208 168.363 326.344 168.934 329.076 168.934C331.758 168.934 334.092 168.338 336.079 167.146C338.115 165.954 339.58 164.216 340.474 161.931L341.89 166.848C340.946 169.182 339.282 171.045 336.898 172.435C334.514 173.776 331.509 174.447 327.884 174.447Z" fill="black"/>
14 | <path d="M289.393 174.447C285.171 174.447 281.446 173.578 278.218 171.839C275.039 170.101 272.556 167.717 270.768 164.687C269.029 161.658 268.16 158.181 268.16 154.257C268.16 150.334 269.004 146.857 270.693 143.827C272.431 140.798 274.791 138.439 277.771 136.75C280.8 135.012 284.202 134.142 287.977 134.142C291.801 134.142 295.179 134.987 298.109 136.675C301.039 138.364 303.324 140.748 304.963 143.827C306.652 146.857 307.496 150.408 307.496 154.481C307.496 154.779 307.471 155.127 307.422 155.524C307.422 155.921 307.397 156.294 307.347 156.641H273.748V151.501H303.622L300.717 153.289C300.766 150.756 300.245 148.496 299.152 146.509C298.059 144.523 296.545 142.983 294.608 141.89C292.72 140.748 290.51 140.177 287.977 140.177C285.494 140.177 283.284 140.748 281.347 141.89C279.41 142.983 277.895 144.548 276.802 146.584C275.709 148.571 275.163 150.855 275.163 153.438V154.63C275.163 157.262 275.759 159.621 276.951 161.707C278.193 163.744 279.906 165.333 282.092 166.475C284.277 167.618 286.785 168.189 289.616 168.189C291.95 168.189 294.061 167.792 295.949 166.997C297.886 166.202 299.574 165.01 301.015 163.421L304.963 168.04C303.175 170.126 300.94 171.715 298.258 172.808C295.626 173.901 292.671 174.447 289.393 174.447Z" fill="black"/>
15 | <path d="M218.725 174V121.85H239.063C243.633 121.85 247.532 122.57 250.76 124.011C253.988 125.451 256.472 127.537 258.21 130.268C259.948 133 260.817 136.253 260.817 140.028C260.817 143.803 259.948 147.056 258.21 149.788C256.472 152.469 253.988 154.531 250.76 155.971C247.532 157.411 243.633 158.132 239.063 158.132H222.822L226.175 154.704V174H218.725ZM253.591 174L240.33 155.077H248.301L261.711 174H253.591ZM226.175 155.45L222.822 151.799H238.84C243.608 151.799 247.209 150.781 249.642 148.745C252.126 146.659 253.367 143.753 253.367 140.028C253.367 136.303 252.126 133.422 249.642 131.386C247.209 129.35 243.608 128.331 238.84 128.331H222.822L226.175 124.606V155.45Z" fill="black"/>
16 | </svg>
17 |
```
--------------------------------------------------------------------------------
/.gitbook/assets/openfeature.svg:
--------------------------------------------------------------------------------
```
1 | <svg width="512" height="289" viewBox="0 0 512 289" fill="none" xmlns="http://www.w3.org/2000/svg">
2 | <style>
3 | @media (prefers-color-scheme: dark) {
4 | path { fill: white; }
5 | }
6 | </style>
7 | <path d="M115.743 124H92.6085C87.1424 124 81.9022 126.132 78.0393 129.943C74.1765 133.743 72.0029 138.9 72.0029 144.283C72.0029 149.666 74.1765 154.823 78.0393 158.624C81.9022 162.424 87.1424 164.567 92.6085 164.567H115.743C121.209 164.567 126.449 162.435 130.312 158.624C134.175 154.823 136.348 149.666 136.348 144.283C136.348 138.9 134.175 133.743 130.312 129.943C126.449 126.142 121.209 124 115.743 124ZM115.829 159.216C112.827 159.216 109.889 158.344 107.404 156.697C104.907 155.06 102.96 152.724 101.819 149.989C100.668 147.255 100.367 144.251 100.958 141.355C101.539 138.459 102.992 135.8 105.112 133.711C107.231 131.622 109.932 130.201 112.88 129.62C115.829 129.039 118.874 129.34 121.65 130.47C124.426 131.601 126.793 133.517 128.461 135.972C130.129 138.427 131.022 141.312 131.022 144.273C131.022 146.243 130.635 148.181 129.871 150C129.107 151.82 127.988 153.467 126.578 154.856C125.169 156.245 123.49 157.343 121.639 158.096C119.799 158.85 117.819 159.227 115.818 159.227H115.85L115.829 159.216ZM152.51 134.594C154.651 133.388 157.083 132.785 159.547 132.839C162.172 132.807 164.766 133.485 167.025 134.788C169.274 136.09 171.104 137.985 172.308 140.268C173.632 142.798 174.299 145.618 174.234 148.471C174.289 151.335 173.632 154.167 172.308 156.707C171.125 159.033 169.295 160.971 167.036 162.327C164.776 163.684 162.184 164.373 159.547 164.33C157.104 164.384 154.694 163.77 152.575 162.575C150.691 161.52 149.099 160.023 147.969 158.204V178.283H142.826V133.345H147.969V138.965C149.067 137.135 150.638 135.627 152.521 134.594H152.51ZM167.563 142.453C166.692 140.827 165.368 139.471 163.744 138.556C162.129 137.662 160.311 137.21 158.46 137.221C156.631 137.21 154.824 137.684 153.242 138.588C151.617 139.525 150.282 140.892 149.4 142.528C148.442 144.402 147.947 146.458 147.947 148.558C147.947 150.657 148.442 152.713 149.4 154.587C150.282 156.223 151.617 157.59 153.242 158.527C154.824 159.431 156.631 159.905 158.46 159.894C160.311 159.905 162.129 159.442 163.744 158.527C165.368 157.59 166.692 156.223 167.563 154.587C168.542 152.702 169.027 150.614 168.973 148.504C169.027 146.404 168.542 144.326 167.563 142.464V142.453ZM206.87 150.463H182.132C182.132 151.744 182.401 153.015 182.907 154.199C183.413 155.383 184.166 156.449 185.102 157.343C186.038 158.236 187.147 158.936 188.373 159.399C189.589 159.862 190.891 160.077 192.193 160.034C194.162 160.099 196.11 159.571 197.756 158.505C199.219 157.515 200.317 156.083 200.887 154.414H206.418C205.632 157.289 203.878 159.808 201.447 161.563C198.757 163.458 195.496 164.427 192.182 164.319C189.417 164.362 186.684 163.673 184.274 162.338C181.96 161.046 180.067 159.13 178.818 156.815C177.462 154.253 176.785 151.389 176.849 148.504C176.785 145.629 177.441 142.776 178.764 140.214C179.981 137.91 181.853 136.004 184.155 134.734C186.609 133.42 189.363 132.764 192.15 132.817C194.872 132.764 197.563 133.42 199.94 134.712C202.146 135.918 203.964 137.727 205.17 139.912C206.418 142.216 207.053 144.789 207.01 147.395C207.01 148.428 206.977 149.462 206.87 150.485V150.463ZM200.435 141.377C199.585 140.009 198.37 138.911 196.906 138.201C195.367 137.468 193.678 137.092 191.967 137.113C189.524 137.049 187.147 137.91 185.339 139.525C183.445 141.301 182.315 143.734 182.208 146.307H201.748C201.791 144.574 201.339 142.862 200.446 141.366L200.435 141.377ZM235.847 136.144C238.182 138.394 239.344 141.624 239.344 145.844V163.802H234.265V146.566C234.265 143.53 233.501 141.204 231.952 139.589C231.134 138.771 230.144 138.136 229.047 137.716C227.959 137.296 226.787 137.113 225.625 137.178C224.43 137.124 223.236 137.318 222.117 137.748C220.998 138.179 219.997 138.836 219.158 139.686C217.522 141.355 216.726 143.788 216.748 146.975V163.845H211.604V133.345H216.748V137.684C217.77 136.123 219.201 134.874 220.901 134.066C222.709 133.205 224.688 132.764 226.69 132.785C228.368 132.71 230.036 132.979 231.607 133.55C233.178 134.131 234.62 135.003 235.836 136.144H235.847ZM267.804 125.055V129.179H250.674V142.259H264.544V146.383H250.674V163.835H245.531V125.055H267.804ZM299.88 150.463H275.132C275.132 151.744 275.401 153.015 275.907 154.199C276.423 155.383 277.166 156.449 278.102 157.343C279.037 158.236 280.146 158.936 281.373 159.399C282.588 159.862 283.89 160.077 285.193 160.034C287.162 160.099 289.109 159.571 290.756 158.505C292.219 157.515 293.317 156.083 293.887 154.414H299.417C298.632 157.289 296.889 159.808 294.446 161.563C291.756 163.458 288.496 164.427 285.193 164.319C282.438 164.362 279.716 163.695 277.316 162.37C275.003 161.079 273.109 159.162 271.871 156.847C270.526 154.285 269.849 151.421 269.924 148.536C269.859 145.661 270.516 142.808 271.839 140.246C273.055 137.942 274.928 136.037 277.23 134.766C279.683 133.453 282.438 132.796 285.225 132.85C287.947 132.796 290.637 133.453 293.015 134.745C295.221 135.961 297.04 137.759 298.244 139.945C299.482 142.249 300.117 144.822 300.074 147.427C300.074 148.45 299.998 149.473 299.88 150.485V150.463ZM293.435 141.377C292.585 140.02 291.369 138.933 289.905 138.233C288.367 137.501 286.677 137.124 284.966 137.145C282.524 137.081 280.146 137.942 278.338 139.557C276.445 141.333 275.315 143.767 275.196 146.34H294.779C294.822 144.596 294.349 142.873 293.446 141.366L293.435 141.377ZM304.615 140.268C305.819 137.996 307.649 136.09 309.898 134.788C312.168 133.474 314.761 132.807 317.386 132.839C319.851 132.785 322.293 133.377 324.445 134.562C326.307 135.574 327.856 137.081 328.911 138.9V133.345H334.108V163.813H328.911V158.139C327.824 159.991 326.253 161.52 324.37 162.564C322.229 163.759 319.797 164.362 317.333 164.319C314.718 164.351 312.146 163.662 309.898 162.338C307.659 160.971 305.841 159.033 304.647 156.718C303.334 154.177 302.678 151.346 302.732 148.493C302.656 145.64 303.312 142.819 304.625 140.278L304.615 140.268ZM327.458 142.518C326.586 140.881 325.263 139.525 323.649 138.599C322.035 137.716 320.228 137.253 318.388 137.253C316.548 137.253 314.729 137.716 313.126 138.599C311.512 139.514 310.199 140.871 309.339 142.496C308.359 144.348 307.875 146.415 307.929 148.504C307.875 150.614 308.359 152.713 309.339 154.587C310.199 156.223 311.512 157.59 313.126 158.527C314.718 159.442 316.526 159.916 318.377 159.894C320.228 159.905 322.057 159.442 323.66 158.527C325.285 157.59 326.608 156.223 327.469 154.587C328.438 152.724 328.933 150.646 328.878 148.558C328.943 146.458 328.469 144.38 327.501 142.518H327.469H327.458ZM346.859 137.511V155.469C346.805 156.029 346.859 156.6 347.02 157.138C347.181 157.676 347.461 158.182 347.817 158.613C348.451 159.227 349.57 159.528 351.152 159.528H354.929V163.813H350.302C347.439 163.813 345.288 163.167 343.857 161.864C342.426 160.562 341.715 158.43 341.715 155.437V137.511H337.712V133.345H341.704V125.658H346.848V133.334H354.929V137.501H346.859V137.511ZM386.391 133.345V163.813H381.248V159.313C380.258 160.885 378.848 162.144 377.169 162.952C375.372 163.835 373.393 164.276 371.381 164.265C369.11 164.308 366.873 163.802 364.849 162.79C362.913 161.8 361.331 160.26 360.298 158.376C359.136 156.158 358.577 153.693 358.663 151.206V133.345H363.719V150.528C363.719 153.531 364.494 155.835 366.033 157.45C366.851 158.269 367.841 158.904 368.928 159.324C370.014 159.744 371.187 159.927 372.35 159.862C373.554 159.927 374.76 159.733 375.889 159.302C377.019 158.871 378.031 158.204 378.88 157.353C380.452 155.695 381.248 153.262 381.248 150.065V133.345H386.369H386.391ZM401.896 134.217C403.769 133.205 405.889 132.699 408.019 132.774V137.996H406.663C400.896 137.996 398.012 141.075 398.012 147.223V163.792H392.868V133.345H397.98V138.297C398.84 136.596 400.197 135.175 401.875 134.228L401.896 134.217ZM439.815 150.463H415.078C415.078 151.744 415.336 153.015 415.853 154.199C416.358 155.383 417.111 156.449 418.047 157.343C418.983 158.236 420.092 158.936 421.318 159.399C422.534 159.862 423.836 160.077 425.139 160.034C427.108 160.11 429.055 159.571 430.701 158.505C432.176 157.515 433.273 156.083 433.832 154.414H439.374C438.589 157.278 436.835 159.797 434.403 161.563C431.702 163.458 428.453 164.427 425.139 164.319C422.384 164.362 419.672 163.695 417.262 162.37C414.948 161.079 413.055 159.162 411.817 156.847C410.45 154.285 409.773 151.421 409.837 148.536C409.773 145.661 410.44 142.808 411.764 140.246C412.979 137.942 414.852 136.037 417.154 134.766C419.597 133.453 422.351 132.796 425.139 132.85C427.86 132.796 430.551 133.453 432.939 134.745C435.145 135.95 436.953 137.759 438.158 139.945C439.406 142.249 440.041 144.822 439.998 147.427C439.998 148.45 439.933 149.473 439.826 150.485L439.815 150.463ZM433.38 141.377C432.53 140.009 431.282 138.922 429.819 138.233C428.291 137.501 426.623 137.135 424.923 137.145C422.481 137.081 420.102 137.942 418.284 139.557C416.391 141.333 415.26 143.767 415.153 146.34H434.736C434.768 144.596 434.306 142.873 433.391 141.366L433.38 141.377Z" fill="black"/>
8 | </svg>
9 |
```
--------------------------------------------------------------------------------
/.gitbook/assets/segment.svg:
--------------------------------------------------------------------------------
```
1 | <svg width="512" height="290" viewBox="0 0 512 290" fill="none" xmlns="http://www.w3.org/2000/svg">
2 | <style>
3 | @media (prefers-color-scheme: dark) {
4 | path { fill: white; }
5 | }
6 | </style>
7 | <path d="M149.125 138.981H107.839C106.262 138.981 104.974 137.703 104.974 136.191V131.366C104.974 129.828 106.288 128.576 107.839 128.576H149.387C150.964 128.576 152.252 129.854 152.252 131.366V136.191C151.989 137.729 150.675 138.981 149.125 138.981Z" fill="#6ADDB2"/>
8 | <path d="M76.3029 159.842C74.7261 159.842 73.4121 158.538 73.4121 156.974V152.019C73.4121 150.715 74.7261 149.412 76.3029 149.412H117.983C119.56 149.412 120.874 150.715 120.874 152.28V157.235C120.611 158.538 119.297 159.842 117.72 159.842H76.3029Z" fill="#6ADDB2"/>
9 | <path d="M89.0486 178.096C91.9394 178.096 94.3046 175.749 94.3046 172.881C94.3046 170.012 91.9394 167.665 89.0486 167.665C86.1578 167.665 83.7926 170.012 83.7926 172.881C83.7926 175.749 86.1578 178.096 89.0486 178.096Z" fill="#6ADDB2"/>
10 | <path d="M136.353 120.727C139.243 120.727 141.609 118.38 141.609 115.512C141.609 112.643 139.243 110.296 136.353 110.296C133.462 110.296 131.097 112.643 131.097 115.512C131.097 118.38 133.462 120.727 136.353 120.727Z" fill="#6ADDB2"/>
11 | <path d="M112.701 175.488C109.81 175.488 106.919 174.967 104.291 174.185C102.977 173.924 101.663 174.445 101.137 175.749L99.2978 180.704C98.7722 182.008 99.5606 183.572 101.137 184.094C104.817 185.398 108.759 185.919 112.701 185.919C129.783 185.919 144.499 175.749 151.069 161.146C151.595 159.842 151.069 158.017 149.493 157.495L144.499 155.67C143.185 155.148 141.871 155.67 141.346 156.974C136.353 167.926 125.578 175.488 112.701 175.488Z" fill="#6ADDB2"/>
12 | <path d="M112.701 112.904C115.591 112.904 118.482 113.425 121.11 114.208C122.424 114.468 123.738 113.947 124.264 112.643L126.103 107.688C126.629 106.385 125.841 104.82 124.264 104.298C120.585 102.995 116.643 102.473 112.701 102.473C95.6187 102.473 80.9019 112.643 74.3319 127.246C73.8063 128.55 74.3319 130.375 75.9087 130.897L80.9019 132.722C82.2159 133.244 83.5299 132.722 84.0555 131.418C89.0487 120.466 99.8235 112.904 112.701 112.904Z" fill="#6ADDB2"/>
13 | <path d="M185.128 178.122V172.568C189.438 176.792 194.405 179.009 199.714 179.009C204.208 179.009 206.783 176.871 206.783 173.507C206.783 169.282 202.683 168.813 197.979 168.291C191.909 167.587 184.603 166.674 184.603 158.799C184.603 152.202 190.043 148.368 197.217 148.368C204.391 148.368 208.596 150.741 211.461 152.932V158.434C207.782 154.601 202.946 152.697 197.401 152.645C192.382 152.645 189.937 154.966 189.937 158.33C189.937 162.215 194.195 162.789 198.925 163.311C205.048 164.015 212.249 165.058 212.249 173.089C212.249 179.296 207.466 183.39 199.976 183.39C192.487 183.39 188.597 181.069 185.155 178.122H185.128Z" fill="#121C2D"/>
14 | <path d="M216.717 165.501C216.717 154.888 223.366 148.342 232.59 148.342C241.289 148.342 247.543 153.61 247.543 164.614V167.222H222.209C222.682 175.567 228.333 178.878 236.059 178.878C241.21 178.878 244.521 177.027 246.86 175.123V180C244.994 181.46 241.551 183.416 235.113 183.416C223.681 183.416 216.717 177.157 216.717 166.335V165.501ZM222.262 163.18H242.051C241.709 156.113 238.188 152.645 232.537 152.645C226.887 152.645 223.024 156.061 222.262 163.18Z" fill="#121C2D"/>
15 | <path d="M250.828 189.022C250.828 185.267 253.745 182.529 260.578 182.06C260.631 182.06 260.683 182.008 260.683 181.956C260.683 181.903 260.631 181.851 260.578 181.851C254.56 181.851 252.352 180.391 252.352 177.496C252.352 174.837 255.164 172.333 261.997 172.281C262.05 172.281 262.102 172.229 262.102 172.177C262.102 172.125 262.05 172.072 261.997 172.072C256.032 171.212 252.536 167.04 252.536 160.729C252.536 153.323 258.265 148.395 266.675 148.395C270.591 148.395 272.457 148.968 274.953 148.968H283.994V153.375H277.056C279.263 154.94 280.682 157.939 280.682 161.25C280.682 167.744 275.61 172.959 266.964 172.959H264.862C260.184 172.959 257.74 173.95 257.74 175.671C257.74 177.522 259.369 177.809 265.571 177.809H271.826C279.815 177.809 283.862 179.843 283.862 185.632C283.862 191.421 278.843 196.011 266.228 196.011H265.414C254.271 196.011 250.881 193.221 250.881 189.048L250.828 189.022ZM278.501 186.415C278.501 183.285 275.926 182.477 270.67 182.477H265.125C258.476 182.477 256.189 184.85 256.189 187.588C256.189 190.092 258.712 191.813 265.887 191.813H266.517C275.269 191.813 278.475 189.726 278.475 186.415H278.501ZM275.4 160.859C275.4 155.983 272.299 152.176 266.649 152.176C260.999 152.176 257.845 155.54 257.845 160.859C257.845 165.501 260.946 169.021 266.649 169.021C272.352 169.021 275.4 165.501 275.4 160.859Z" fill="#121C2D"/>
16 | <path d="M288.566 148.942H293.927V160.416C294.926 152.071 298.71 148.368 305.307 148.368C312.718 148.368 316.581 152.645 317.212 159.999C318.21 152.228 322.047 148.368 328.643 148.368C336.711 148.368 340.732 153.688 340.732 162.606V182.816H335.292V163.65C335.292 157.156 332.717 152.802 326.541 152.802C321.232 152.802 317.317 156.87 317.369 164.093V182.816H311.929V163.232C311.929 157.026 309.301 152.802 303.178 152.802C297.975 152.802 293.954 156.87 293.954 164.745V182.816H288.514V148.916L288.566 148.942Z" fill="#121C2D"/>
17 | <path d="M346.303 165.501C346.303 154.888 352.952 148.342 362.177 148.342C370.875 148.342 377.13 153.61 377.13 164.614V167.222H351.796C352.269 175.567 357.919 178.878 365.646 178.878C370.796 178.878 374.108 177.027 376.447 175.123V180C374.581 181.46 371.138 183.416 364.699 183.416C353.268 183.416 346.303 177.157 346.303 166.335V165.501ZM351.849 163.18H371.637C371.296 156.113 367.774 152.645 362.124 152.645C356.474 152.645 352.611 156.061 351.849 163.18Z" fill="#121C2D"/>
18 | <path d="M388.246 148.942V160.364C389.403 151.785 393.792 148.368 400.283 148.368C409.034 148.368 413.239 153.766 413.239 162.972V182.842H407.799V164.067C407.799 157.182 405.066 152.828 398.285 152.828C392.609 152.828 388.299 157.104 388.299 165.345V182.842H382.859V148.942H388.246Z" fill="#121C2D"/>
19 | <path d="M422.41 172.568V153.323H416.235V149.438L418.101 149.385C421.648 149.203 422.778 147.873 423.067 143.596L423.251 141.093H427.85V148.916H439.466V153.323H427.85V172.385C427.85 176.792 429.9 178.748 433.921 178.748C436.023 178.748 438.126 178.279 439.466 177.418V181.643C438.126 182.503 435.734 183.259 432.397 183.259C425.511 183.259 422.41 179.948 422.41 172.542V172.568Z" fill="#121C2D"/>
20 | <path d="M213.484 133.087L206.126 107.193V114.051C206.126 114.416 205.889 114.651 205.522 114.651H200.686V121.874C200.686 124.456 201.343 125.212 203.419 125.212C204.208 125.212 204.97 125.16 205.653 124.847C206.179 124.586 206.573 124.795 206.573 125.212V132.488C206.573 132.905 206.415 133.166 206.021 133.348C204.681 133.974 202.131 134.365 199.03 134.365C191.015 134.365 188.387 130.61 188.387 123.987V114.625H184.419C184.051 114.625 183.788 114.364 183.788 113.999V106.306C183.788 105.941 184.051 105.681 184.419 105.681H187.073C188.15 105.681 188.729 105.211 188.729 104.142V99.8133C188.729 99.4482 188.939 99.1353 189.307 99.031L199.582 95.7453C200.108 95.5888 200.423 95.7974 200.423 96.2668V105.42H216.769C217.137 105.42 217.348 105.576 217.453 105.994L219.844 118.432L222.236 105.994C222.288 105.628 222.551 105.42 222.919 105.42H233.878C234.246 105.42 234.508 105.628 234.561 105.994L237.031 118.432L239.475 105.994C239.58 105.576 239.791 105.42 240.159 105.42H261.734C262.102 105.42 262.365 105.681 262.365 106.046V132.957C262.365 133.322 262.102 133.583 261.734 133.583H250.644C250.276 133.583 250.014 133.322 250.014 132.957V107.193L242.971 133.087C242.865 133.452 242.603 133.609 242.182 133.609H232.117C231.749 133.609 231.591 133.452 231.486 133.087L228.254 120.857L224.916 133.087C224.811 133.452 224.653 133.609 224.285 133.609H214.22C213.8 133.609 213.537 133.452 213.432 133.087H213.484ZM250.014 102.395C250.014 102.76 250.276 103.021 250.644 103.021H261.734C262.102 103.021 262.365 102.76 262.365 102.395V96.319C262.365 95.9539 262.102 95.6931 261.734 95.6931H250.644C250.276 95.6931 250.014 95.9539 250.014 96.319V102.421V102.395ZM264.809 132.983C264.809 133.348 265.072 133.609 265.44 133.609H276.53C276.898 133.609 277.161 133.348 277.161 132.983V96.319C277.161 95.9539 276.898 95.6931 276.53 95.6931H265.44C265.072 95.6931 264.809 95.9539 264.809 96.319V133.009V132.983ZM279.605 132.983C279.605 133.348 279.868 133.609 280.236 133.609H291.299C291.667 133.609 291.93 133.348 291.93 132.983V106.098C291.93 105.733 291.667 105.472 291.299 105.472H280.236C279.868 105.472 279.605 105.733 279.605 106.098V133.009V132.983ZM279.605 102.395C279.605 102.76 279.868 103.021 280.236 103.021H291.299C291.667 103.021 291.93 102.76 291.93 102.395V96.319C291.93 95.9539 291.667 95.6931 291.299 95.6931H280.236C279.868 95.6931 279.605 95.9539 279.605 96.319V102.421V102.395ZM325.7 119.11V119.788C325.7 128.159 319.288 134.469 309.801 134.469C300.313 134.469 293.849 128.159 293.849 119.788V119.11C293.849 110.74 300.34 104.611 309.801 104.611C319.261 104.611 325.7 110.74 325.7 119.11ZM313.874 119.293C313.874 115.433 312.087 113.921 309.801 113.921C307.514 113.921 305.727 115.433 305.727 119.293V119.788C305.727 123.595 307.514 125.186 309.801 125.186C312.087 125.186 313.874 123.595 313.874 119.788V119.293Z" fill="#121C2D"/>
21 | </svg>
22 |
```
--------------------------------------------------------------------------------
/.gitbook/assets/segment (1).svg:
--------------------------------------------------------------------------------
```
1 | <svg width="512" height="290" viewBox="0 0 512 290" fill="none" xmlns="http://www.w3.org/2000/svg">
2 | <rect width="512" height="288.257" transform="translate(0 0.871315)" fill="white"/>
3 | <g clip-path="url(#clip0_1_40)">
4 | <path d="M149.125 138.981H107.839C106.262 138.981 104.974 137.703 104.974 136.191V131.366C104.974 129.828 106.288 128.576 107.839 128.576H149.387C150.964 128.576 152.252 129.854 152.252 131.366V136.191C151.989 137.729 150.675 138.981 149.125 138.981Z" fill="#6ADDB2"/>
5 | <path d="M76.3029 159.842C74.7261 159.842 73.4121 158.538 73.4121 156.974V152.019C73.4121 150.715 74.7261 149.412 76.3029 149.412H117.983C119.56 149.412 120.874 150.715 120.874 152.28V157.235C120.611 158.538 119.297 159.842 117.72 159.842H76.3029Z" fill="#6ADDB2"/>
6 | <path d="M89.0486 178.096C91.9394 178.096 94.3046 175.749 94.3046 172.881C94.3046 170.012 91.9394 167.665 89.0486 167.665C86.1578 167.665 83.7926 170.012 83.7926 172.881C83.7926 175.749 86.1578 178.096 89.0486 178.096Z" fill="#6ADDB2"/>
7 | <path d="M136.353 120.727C139.243 120.727 141.609 118.38 141.609 115.512C141.609 112.643 139.243 110.296 136.353 110.296C133.462 110.296 131.097 112.643 131.097 115.512C131.097 118.38 133.462 120.727 136.353 120.727Z" fill="#6ADDB2"/>
8 | <path d="M112.701 175.488C109.81 175.488 106.919 174.967 104.291 174.185C102.977 173.924 101.663 174.445 101.137 175.749L99.2978 180.704C98.7722 182.008 99.5606 183.572 101.137 184.094C104.817 185.398 108.759 185.919 112.701 185.919C129.783 185.919 144.499 175.749 151.069 161.146C151.595 159.842 151.069 158.017 149.493 157.495L144.499 155.67C143.185 155.148 141.871 155.67 141.346 156.974C136.353 167.926 125.578 175.488 112.701 175.488Z" fill="#6ADDB2"/>
9 | <path d="M112.701 112.904C115.591 112.904 118.482 113.425 121.11 114.208C122.424 114.468 123.738 113.947 124.264 112.643L126.103 107.688C126.629 106.385 125.841 104.82 124.264 104.298C120.585 102.995 116.643 102.473 112.701 102.473C95.6187 102.473 80.9019 112.643 74.3319 127.246C73.8063 128.55 74.3319 130.375 75.9087 130.897L80.9019 132.722C82.2159 133.244 83.5299 132.722 84.0555 131.418C89.0487 120.466 99.8235 112.904 112.701 112.904Z" fill="#6ADDB2"/>
10 | <path d="M185.128 178.122V172.568C189.438 176.792 194.405 179.009 199.714 179.009C204.208 179.009 206.783 176.871 206.783 173.507C206.783 169.282 202.683 168.813 197.979 168.291C191.909 167.587 184.603 166.674 184.603 158.799C184.603 152.202 190.043 148.368 197.217 148.368C204.391 148.368 208.596 150.741 211.461 152.932V158.434C207.782 154.601 202.946 152.697 197.401 152.645C192.382 152.645 189.937 154.966 189.937 158.33C189.937 162.215 194.195 162.789 198.925 163.311C205.048 164.015 212.249 165.058 212.249 173.089C212.249 179.296 207.466 183.39 199.976 183.39C192.487 183.39 188.597 181.069 185.155 178.122H185.128Z" fill="#121C2D"/>
11 | <path d="M216.717 165.501C216.717 154.888 223.366 148.342 232.59 148.342C241.289 148.342 247.543 153.61 247.543 164.614V167.222H222.209C222.682 175.567 228.333 178.878 236.059 178.878C241.21 178.878 244.521 177.027 246.86 175.123V180C244.994 181.46 241.551 183.416 235.113 183.416C223.681 183.416 216.717 177.157 216.717 166.335V165.501ZM222.262 163.18H242.051C241.709 156.113 238.188 152.645 232.537 152.645C226.887 152.645 223.024 156.061 222.262 163.18Z" fill="#121C2D"/>
12 | <path d="M250.828 189.022C250.828 185.267 253.745 182.529 260.578 182.06C260.631 182.06 260.683 182.008 260.683 181.956C260.683 181.903 260.631 181.851 260.578 181.851C254.56 181.851 252.352 180.391 252.352 177.496C252.352 174.837 255.164 172.333 261.997 172.281C262.05 172.281 262.102 172.229 262.102 172.177C262.102 172.125 262.05 172.072 261.997 172.072C256.032 171.212 252.536 167.04 252.536 160.729C252.536 153.323 258.265 148.395 266.675 148.395C270.591 148.395 272.457 148.968 274.953 148.968H283.994V153.375H277.056C279.263 154.94 280.682 157.939 280.682 161.25C280.682 167.744 275.61 172.959 266.964 172.959H264.862C260.184 172.959 257.74 173.95 257.74 175.671C257.74 177.522 259.369 177.809 265.571 177.809H271.826C279.815 177.809 283.862 179.843 283.862 185.632C283.862 191.421 278.843 196.011 266.228 196.011H265.414C254.271 196.011 250.881 193.221 250.881 189.048L250.828 189.022ZM278.501 186.415C278.501 183.285 275.926 182.477 270.67 182.477H265.125C258.476 182.477 256.189 184.85 256.189 187.588C256.189 190.092 258.712 191.813 265.887 191.813H266.517C275.269 191.813 278.475 189.726 278.475 186.415H278.501ZM275.4 160.859C275.4 155.983 272.299 152.176 266.649 152.176C260.999 152.176 257.845 155.54 257.845 160.859C257.845 165.501 260.946 169.021 266.649 169.021C272.352 169.021 275.4 165.501 275.4 160.859Z" fill="#121C2D"/>
13 | <path d="M288.566 148.942H293.927V160.416C294.926 152.071 298.71 148.368 305.307 148.368C312.718 148.368 316.581 152.645 317.212 159.999C318.21 152.228 322.047 148.368 328.643 148.368C336.711 148.368 340.732 153.688 340.732 162.606V182.816H335.292V163.65C335.292 157.156 332.717 152.802 326.541 152.802C321.232 152.802 317.317 156.87 317.369 164.093V182.816H311.929V163.232C311.929 157.026 309.301 152.802 303.178 152.802C297.975 152.802 293.954 156.87 293.954 164.745V182.816H288.514V148.916L288.566 148.942Z" fill="#121C2D"/>
14 | <path d="M346.303 165.501C346.303 154.888 352.952 148.342 362.177 148.342C370.875 148.342 377.13 153.61 377.13 164.614V167.222H351.796C352.269 175.567 357.919 178.878 365.646 178.878C370.796 178.878 374.108 177.027 376.447 175.123V180C374.581 181.46 371.138 183.416 364.699 183.416C353.268 183.416 346.303 177.157 346.303 166.335V165.501ZM351.849 163.18H371.637C371.296 156.113 367.774 152.645 362.124 152.645C356.474 152.645 352.611 156.061 351.849 163.18Z" fill="#121C2D"/>
15 | <path d="M388.246 148.942V160.364C389.403 151.785 393.792 148.368 400.283 148.368C409.034 148.368 413.239 153.766 413.239 162.972V182.842H407.799V164.067C407.799 157.182 405.066 152.828 398.285 152.828C392.609 152.828 388.299 157.104 388.299 165.345V182.842H382.859V148.942H388.246Z" fill="#121C2D"/>
16 | <path d="M422.41 172.568V153.323H416.235V149.438L418.101 149.385C421.648 149.203 422.778 147.873 423.067 143.596L423.251 141.093H427.85V148.916H439.466V153.323H427.85V172.385C427.85 176.792 429.9 178.748 433.921 178.748C436.023 178.748 438.126 178.279 439.466 177.418V181.643C438.126 182.503 435.734 183.259 432.397 183.259C425.511 183.259 422.41 179.948 422.41 172.542V172.568Z" fill="#121C2D"/>
17 | <path d="M213.484 133.087L206.126 107.193V114.051C206.126 114.416 205.889 114.651 205.522 114.651H200.686V121.874C200.686 124.456 201.343 125.212 203.419 125.212C204.208 125.212 204.97 125.16 205.653 124.847C206.179 124.586 206.573 124.795 206.573 125.212V132.488C206.573 132.905 206.415 133.166 206.021 133.348C204.681 133.974 202.131 134.365 199.03 134.365C191.015 134.365 188.387 130.61 188.387 123.987V114.625H184.419C184.051 114.625 183.788 114.364 183.788 113.999V106.306C183.788 105.941 184.051 105.681 184.419 105.681H187.073C188.15 105.681 188.729 105.211 188.729 104.142V99.8133C188.729 99.4482 188.939 99.1353 189.307 99.031L199.582 95.7453C200.108 95.5888 200.423 95.7974 200.423 96.2668V105.42H216.769C217.137 105.42 217.348 105.576 217.453 105.994L219.844 118.432L222.236 105.994C222.288 105.628 222.551 105.42 222.919 105.42H233.878C234.246 105.42 234.508 105.628 234.561 105.994L237.031 118.432L239.475 105.994C239.58 105.576 239.791 105.42 240.159 105.42H261.734C262.102 105.42 262.365 105.681 262.365 106.046V132.957C262.365 133.322 262.102 133.583 261.734 133.583H250.644C250.276 133.583 250.014 133.322 250.014 132.957V107.193L242.971 133.087C242.865 133.452 242.603 133.609 242.182 133.609H232.117C231.749 133.609 231.591 133.452 231.486 133.087L228.254 120.857L224.916 133.087C224.811 133.452 224.653 133.609 224.285 133.609H214.22C213.8 133.609 213.537 133.452 213.432 133.087H213.484ZM250.014 102.395C250.014 102.76 250.276 103.021 250.644 103.021H261.734C262.102 103.021 262.365 102.76 262.365 102.395V96.319C262.365 95.9539 262.102 95.6931 261.734 95.6931H250.644C250.276 95.6931 250.014 95.9539 250.014 96.319V102.421V102.395ZM264.809 132.983C264.809 133.348 265.072 133.609 265.44 133.609H276.53C276.898 133.609 277.161 133.348 277.161 132.983V96.319C277.161 95.9539 276.898 95.6931 276.53 95.6931H265.44C265.072 95.6931 264.809 95.9539 264.809 96.319V133.009V132.983ZM279.605 132.983C279.605 133.348 279.868 133.609 280.236 133.609H291.299C291.667 133.609 291.93 133.348 291.93 132.983V106.098C291.93 105.733 291.667 105.472 291.299 105.472H280.236C279.868 105.472 279.605 105.733 279.605 106.098V133.009V132.983ZM279.605 102.395C279.605 102.76 279.868 103.021 280.236 103.021H291.299C291.667 103.021 291.93 102.76 291.93 102.395V96.319C291.93 95.9539 291.667 95.6931 291.299 95.6931H280.236C279.868 95.6931 279.605 95.9539 279.605 96.319V102.421V102.395ZM325.7 119.11V119.788C325.7 128.159 319.288 134.469 309.801 134.469C300.313 134.469 293.849 128.159 293.849 119.788V119.11C293.849 110.74 300.34 104.611 309.801 104.611C319.261 104.611 325.7 110.74 325.7 119.11ZM313.874 119.293C313.874 115.433 312.087 113.921 309.801 113.921C307.514 113.921 305.727 115.433 305.727 119.293V119.788C305.727 123.595 307.514 125.186 309.801 125.186C312.087 125.186 313.874 123.595 313.874 119.788V119.293Z" fill="#121C2D"/>
18 | </g>
19 | <defs>
20 | <clipPath id="clip0_1_40">
21 | <rect width="394.2" height="101.7" fill="white" transform="translate(62.9 94.65)"/>
22 | </clipPath>
23 | </defs>
24 | </svg>
25 |
```
--------------------------------------------------------------------------------
/.gitbook/assets/aws-s3.svg:
--------------------------------------------------------------------------------
```
1 | <svg width="512" height="289" viewBox="0 0 512 289" fill="none" xmlns="http://www.w3.org/2000/svg">
2 | <style>
3 | @media (prefers-color-scheme: dark) {
4 | path { fill: white; }
5 | }
6 | </style>
7 | <path d="M136.51 130.347C136.452 132.073 136.683 133.799 137.144 135.468C137.663 136.906 138.297 138.287 138.988 139.61C139.219 140.013 139.392 140.473 139.392 140.933C139.334 141.623 138.93 142.314 138.297 142.659L134.666 145.075C134.205 145.363 133.686 145.593 133.168 145.593C132.534 145.535 131.9 145.248 131.439 144.788C130.69 143.982 129.941 143.062 129.364 142.084C128.788 141.106 128.212 140.013 127.578 138.689C123.083 143.982 117.436 146.629 110.636 146.629C105.795 146.629 101.934 145.248 99.1101 142.487C96.2864 139.725 94.8457 136.043 94.8457 131.441C94.8457 126.55 96.5745 122.581 100.09 119.589C103.605 116.597 108.273 115.102 114.208 115.102C116.225 115.102 118.3 115.274 120.317 115.562C122.449 115.85 124.639 116.31 126.944 116.828V112.628C126.944 108.255 126.022 105.206 124.236 103.423C122.449 101.639 119.28 100.776 114.842 100.776C112.768 100.776 110.636 101.007 108.619 101.524C106.486 102.042 104.412 102.675 102.395 103.48C101.761 103.768 101.069 103.998 100.378 104.228C100.09 104.343 99.744 104.401 99.4559 104.401C98.6491 104.401 98.2457 103.826 98.2457 102.617V99.7984C98.1881 99.108 98.361 98.4176 98.6491 97.7848C99.1101 97.267 99.6287 96.8643 100.263 96.5766C102.568 95.426 104.988 94.563 107.524 93.9877C110.463 93.2398 113.517 92.8946 116.513 92.8946C123.371 92.8946 128.385 94.448 131.612 97.5546C134.839 100.661 136.395 105.379 136.395 111.707V130.347H136.51ZM113.113 139.092C115.13 139.092 117.147 138.747 119.049 138.056C121.181 137.309 123.025 136.043 124.524 134.375C125.446 133.339 126.137 132.073 126.483 130.693C126.886 129.082 127.059 127.356 127.059 125.687V123.271C125.33 122.868 123.544 122.523 121.758 122.293C119.971 122.063 118.127 121.948 116.341 121.948C112.48 121.948 109.656 122.696 107.754 124.249C105.852 125.802 104.93 127.989 104.93 130.865C104.93 133.569 105.622 135.583 107.063 136.963C108.503 138.344 110.463 139.092 113.113 139.092ZM159.388 145.305C158.639 145.363 157.832 145.19 157.198 144.73C156.622 144.097 156.161 143.349 155.988 142.487L142.446 98.0149C142.158 97.267 141.985 96.5191 141.927 95.7136C141.869 95.0233 142.33 94.3904 143.022 94.2754H149.015C150.11 94.2754 150.859 94.448 151.263 94.8507C151.666 95.2534 152.069 96.0013 152.415 97.0944L162.039 135.18L171.029 97.0944C171.317 95.9438 171.663 95.1959 172.124 94.8507C172.815 94.448 173.622 94.2178 174.429 94.2754H179.039C180.134 94.2754 180.883 94.448 181.344 94.8507C181.92 95.4835 182.324 96.2314 182.439 97.0944L191.544 135.64L201.514 97.0944C201.686 96.2314 202.09 95.4835 202.666 94.8507C203.358 94.448 204.107 94.2178 204.914 94.2754H210.273C210.964 94.1603 211.598 94.6781 211.714 95.3685V95.7136C211.714 96.0013 211.656 96.3465 211.598 96.6341C211.483 97.1519 211.368 97.6122 211.195 98.0724L197.307 142.544C196.961 143.695 196.558 144.442 196.097 144.788C195.463 145.19 194.656 145.421 193.907 145.363H188.951C187.856 145.363 187.107 145.19 186.646 144.788C186.07 144.155 185.666 143.349 185.551 142.487L176.618 105.379L167.744 142.429C167.629 143.292 167.225 144.097 166.649 144.73C165.957 145.19 165.151 145.363 164.344 145.305H159.388ZM233.439 146.859C230.442 146.859 227.446 146.514 224.564 145.823C221.683 145.133 219.436 144.385 217.937 143.522C217.188 143.177 216.554 142.601 216.151 141.911C215.92 141.393 215.805 140.875 215.805 140.3V137.366C215.805 136.158 216.266 135.583 217.13 135.583C217.476 135.583 217.822 135.64 218.168 135.755C218.513 135.87 219.032 136.101 219.608 136.331C221.625 137.251 223.758 137.884 225.947 138.344C228.195 138.804 230.5 139.035 232.805 139.035C236.436 139.035 239.259 138.402 241.219 137.136C243.12 135.985 244.273 133.914 244.215 131.671C244.273 130.175 243.696 128.736 242.659 127.643C241.622 126.55 239.663 125.572 236.839 124.652L228.483 122.063C224.276 120.74 221.164 118.783 219.263 116.195C217.418 113.778 216.381 110.902 216.381 107.853C216.324 105.609 216.842 103.423 217.937 101.467C218.974 99.6258 220.358 98.0149 222.086 96.7492C223.873 95.3685 225.89 94.3904 228.08 93.7576C230.442 93.0672 232.863 92.722 235.341 92.7796C236.608 92.7796 237.934 92.8371 239.202 93.0097C240.527 93.1823 241.737 93.4124 242.947 93.6425C244.158 93.8727 245.195 94.2178 246.232 94.563C247.097 94.8507 247.903 95.1959 248.652 95.5986C249.344 95.9438 249.92 96.404 250.381 97.0369C250.785 97.6122 250.958 98.245 250.9 98.9354V101.639C250.9 102.847 250.439 103.48 249.574 103.48C248.825 103.365 248.076 103.135 247.385 102.79C243.927 101.237 240.124 100.489 236.32 100.546C233.035 100.546 230.442 101.064 228.656 102.157C226.87 103.25 225.947 104.919 225.947 107.277C225.89 108.831 226.524 110.327 227.676 111.362C228.829 112.455 230.961 113.548 234.015 114.526L242.198 117.115C246.347 118.438 249.344 120.279 251.13 122.638C252.917 124.939 253.839 127.816 253.781 130.693C253.839 132.994 253.32 135.295 252.283 137.366C251.246 139.322 249.805 141.048 248.076 142.429C246.175 143.925 243.985 145.018 241.68 145.651C239.029 146.456 236.263 146.859 233.439 146.859Z" fill="black"/>
8 | <path d="M244.33 174.818C225.371 188.798 197.825 196.22 174.14 196.22C140.947 196.22 111.039 183.966 88.4489 163.6C86.6625 161.989 88.2761 159.803 90.4083 161.068C114.842 175.221 144.981 183.793 176.157 183.793C198.632 183.678 220.876 179.133 241.564 170.446C244.734 169.008 247.442 172.517 244.33 174.818Z" fill="#FF9900"/>
9 | <path d="M252.225 165.844C249.805 162.737 236.205 164.348 230.039 165.096C228.195 165.326 227.907 163.715 229.578 162.507C240.412 154.913 258.219 157.099 260.293 159.631C262.368 162.162 259.717 179.997 249.575 188.511C248.019 189.835 246.52 189.144 247.212 187.418C249.517 181.723 254.646 168.893 252.225 165.844Z" fill="#FF9900"/>
10 | <path d="M353.13 157.445C353.706 158.595 354.57 159.573 355.608 160.321C356.705 161.069 357.913 161.644 359.239 161.932C360.621 162.277 362.062 162.45 363.503 162.45C364.599 162.45 365.635 162.335 366.731 162.22C367.825 162.047 368.922 161.76 369.957 161.242C370.936 160.782 371.801 160.091 372.436 159.286C373.127 158.365 373.473 157.272 373.415 156.122C373.473 154.856 372.953 153.648 372.089 152.785C371.11 151.864 369.901 151.174 368.634 150.656C367.075 150.023 365.464 149.563 363.791 149.16C362.006 148.758 360.16 148.24 358.316 147.722C356.416 147.262 354.57 146.686 352.727 145.996C350.998 145.363 349.327 144.443 347.887 143.292C346.446 142.199 345.293 140.818 344.429 139.207C343.506 137.366 343.047 135.353 343.103 133.282C343.047 130.923 343.623 128.564 344.832 126.493C345.928 124.594 347.425 122.926 349.213 121.66C351.056 120.337 353.13 119.417 355.32 118.784C357.569 118.151 359.872 117.863 362.177 117.863C364.77 117.863 367.308 118.151 369.842 118.726C372.206 119.244 374.394 120.222 376.355 121.603C378.257 122.926 379.813 124.652 380.907 126.666C382.059 128.967 382.636 131.556 382.577 134.145H371.745C371.686 132.821 371.342 131.556 370.765 130.405C370.245 129.427 369.495 128.622 368.575 128.046C367.596 127.471 366.558 127.068 365.464 126.838C364.194 126.608 362.927 126.493 361.659 126.493C360.736 126.493 359.816 126.608 358.951 126.781C358.087 126.953 357.222 127.299 356.473 127.759C355.723 128.219 355.147 128.852 354.688 129.542C354.167 130.348 353.938 131.268 353.994 132.246C353.938 133.109 354.167 133.914 354.57 134.662C355.147 135.468 355.896 136.043 356.819 136.388C358.316 137.021 359.872 137.539 361.43 137.942C363.388 138.459 365.982 139.15 369.151 139.955C370.072 140.128 371.398 140.473 373.127 140.991C374.914 141.509 376.584 142.314 378.14 143.35C379.869 144.5 381.368 145.938 382.462 147.665C383.673 149.505 384.306 151.807 384.306 154.683C384.306 156.927 383.847 159.113 382.924 161.184C382.001 163.198 380.619 164.981 378.89 166.362C376.931 167.916 374.682 169.066 372.262 169.756C369.266 170.619 366.211 171.022 363.1 170.964C360.333 170.964 357.625 170.619 354.917 169.929C352.382 169.296 350.019 168.203 347.945 166.65C345.928 165.154 344.256 163.255 343.103 161.012C341.836 158.48 341.26 155.719 341.375 152.9H352.209C352.15 154.568 352.497 156.064 353.13 157.445ZM405.688 140.243C406.896 140.185 408.049 139.898 409.145 139.438C410.181 139.035 411.104 138.345 411.795 137.481C412.545 136.504 412.889 135.295 412.833 134.087C412.833 131.959 412.142 130.29 410.701 129.197C409.316 128.046 407.587 127.471 405.802 127.471C403.209 127.471 401.307 128.334 399.981 130.002C398.599 131.843 397.964 134.087 398.081 136.388H388.457C388.513 133.972 388.975 131.613 389.839 129.37C390.645 127.356 391.798 125.458 393.353 123.904C394.911 122.351 396.696 121.143 398.713 120.395C400.96 119.532 403.324 119.129 405.688 119.129C407.705 119.129 409.722 119.417 411.68 119.992C413.639 120.567 415.426 121.488 417.04 122.639C418.596 123.789 419.922 125.285 420.901 126.953C421.936 128.737 422.456 130.808 422.398 132.879C422.456 135.123 421.821 137.366 420.669 139.265C419.46 141.164 417.617 142.487 415.426 143.062V143.235C417.961 143.752 420.266 145.133 421.88 147.204C423.494 149.333 424.3 151.922 424.241 154.511C424.3 156.927 423.782 159.343 422.745 161.472C421.765 163.485 420.381 165.211 418.652 166.592C416.867 167.973 414.906 169.066 412.718 169.699C410.469 170.389 408.108 170.792 405.744 170.792C403.15 170.85 400.557 170.389 398.081 169.584C395.891 168.836 393.873 167.628 392.201 166.074C390.53 164.464 389.263 162.565 388.457 160.379C387.534 157.905 387.131 155.316 387.187 152.67H396.811C396.87 153.935 397.043 155.258 397.446 156.467C397.793 157.617 398.369 158.653 399.116 159.631C399.866 160.494 400.73 161.242 401.768 161.702C402.977 162.277 404.247 162.508 405.57 162.508C407.705 162.565 409.778 161.817 411.333 160.436C412.889 159.056 413.697 157.1 413.697 154.683C413.697 152.785 413.35 151.346 412.601 150.368C411.91 149.391 410.93 148.643 409.778 148.182C408.569 147.722 407.299 147.492 406.032 147.434C404.65 147.377 403.382 147.319 402.171 147.319V140.243C403.324 140.358 404.535 140.358 405.688 140.243ZM304.032 93.8729H308.066V195.128H304.032V93.8729Z" fill="black"/>
11 | </svg>
12 |
```
--------------------------------------------------------------------------------
/api/cli.md:
--------------------------------------------------------------------------------
```markdown
1 | ---
2 | layout:
3 | width: default
4 | title:
5 | visible: true
6 | description:
7 | visible: true
8 | tableOfContents:
9 | visible: true
10 | outline:
11 | visible: true
12 | pagination:
13 | visible: true
14 | metadata:
15 | visible: true
16 | ---
17 |
18 | # CLI
19 |
20 | Command-line interface for interacting with Reflag services. The CLI allows you to manage apps, features, authentication, and generate TypeScript types for your Reflag features. With this tool, you can streamline your feature flagging workflow directly from your terminal.
21 |
22 | ## Usage
23 |
24 | Get started by installing the CLI locally in your project:
25 |
26 | ```bash
27 | # npm
28 | npm install --save-dev @reflag/cli
29 |
30 | # yarn
31 | yarn add --dev @reflag/cli
32 | ```
33 |
34 | Then running the `new` command from your project's root directory, initializing the CLI, creating a feature, and generating the types all at once:
35 |
36 | ```bash
37 | # npm
38 | npx reflag new
39 |
40 | # yarn
41 | yarn reflag new
42 | ```
43 |
44 | ### Individual commands
45 |
46 | Instead of running `new` you can call each step individually.
47 |
48 | ```bash
49 | # Initialize Reflag in your project (if not already setup)
50 | npx reflag init
51 |
52 | # Create a new feature
53 | npx reflag features create "My Feature"
54 |
55 | # Generate TypeScript types for your features
56 | npx reflag features types
57 | ```
58 |
59 | ## Configuration
60 |
61 | The CLI creates a `reflag.config.json` file in your project directory when you run `reflag init`. This file contains all the necessary settings for your Reflag integration.
62 |
63 | ### Configuration File Structure
64 |
65 | Here's a comprehensive list of configuration options available in the `reflag.config.json` file:
66 |
67 | ```json
68 | {
69 | "$schema": "https://unpkg.com/@reflag/cli@latest/schema.json",
70 | "baseUrl": "https://app.reflag.com",
71 | "apiUrl": "https://app.reflag.com/api",
72 | "appId": "ap123456789",
73 | "typesOutput": [
74 | {
75 | "path": "gen/features.d.ts",
76 | "format": "react"
77 | }
78 | ]
79 | }
80 | ```
81 |
82 | | Option | Description | Default |
83 | | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
84 | | `$schema` | Autocompletion for the config. `latest` can be replaced with a specific version. | "https://unpkg.com/@reflag/cli@latest/schema.json" |
85 | | `baseUrl` | Base URL for Reflag services. | "https://app.reflag.com" |
86 | | `apiUrl` | API URL for Reflag services (overrides baseUrl for API calls). | "https://app.reflag.com/api" |
87 | | `appId` | Your Reflag application ID. | Required |
88 | | `typesOutput` | Path(s) where TypeScript types will be generated. Can be a string or an array of objects with `path` and `format` properties. Available formats: `react` and `node`. | "gen/features.ts" with format "react" |
89 |
90 | You can override these settings using command-line options for individual commands.
91 |
92 | ## Commands
93 |
94 | ### `reflag init`
95 |
96 | Initialize a new Reflag configuration in your project. This creates a `reflag.config.json` file with your settings and prompts for any required information not provided via options.
97 |
98 | ```bash
99 | npx reflag init [--overwrite]
100 | ```
101 |
102 | Options:
103 |
104 | * `--overwrite`: Overwrite existing configuration file if one exists.
105 | * `--app-id <id>`: Set the application ID.
106 | * `--key-format <format>`: Set the key format for features.
107 |
108 | ### `reflag new [featureName]`
109 |
110 | All-in-one command to get started quickly. This command combines `init`, feature creation, and type generation in a single step. Use this for the fastest way to get up and running with Reflag.
111 |
112 | ```bash
113 | npx reflag new "My Feature" [--app-id ap123456789] [--key my-feature] [--key-format custom] [--out gen/features.ts] [--format react]
114 | ```
115 |
116 | Options:
117 |
118 | * `--key`: Specific key for the feature.
119 | * `--app-id`: App ID to use.
120 | * `--key-format`: Format for feature keys (custom, snake, camel, etc.).
121 | * `--out`: Path to generate TypeScript types.
122 | * `--format`: Format of the generated types (react or node).
123 |
124 | If you prefer more control over each step, you can use the individual commands (`init`, `features create`, `features types`) instead.
125 |
126 | ### `reflag login`
127 |
128 | Log in to your Reflag account. This will authenticate your CLI for subsequent operations and store credentials securely.
129 |
130 | ```bash
131 | npx reflag login
132 | ```
133 |
134 | ### `reflag logout`
135 |
136 | Log out from your Reflag account, removing stored credentials.
137 |
138 | ```bash
139 | npx reflag logout
140 | ```
141 |
142 | ### `reflag features`
143 |
144 | Manage your Reflag features with the following subcommands.
145 |
146 | #### `reflag features create [featureName]`
147 |
148 | Create a new feature in your Reflag app. The command guides you through the feature creation process with interactive prompts if options are not provided.
149 |
150 | ```bash
151 | npx reflag features create "My Feature" [--app-id ap123456789] [--key my-feature] [--key-format custom]
152 | ```
153 |
154 | Options:
155 |
156 | * `--key`: Specific key for the feature.
157 | * `--app-id`: App ID to use.
158 | * `--key-format`: Format for feature keys.
159 |
160 | #### `reflag features list`
161 |
162 | List all features for the current app. This helps you visualize what features are available and their current configurations.
163 |
164 | ```bash
165 | npx reflag features list [--app-id ap123456789]
166 | ```
167 |
168 | Options:
169 |
170 | * `--app-id`: App ID to use.
171 |
172 | #### `reflag features types`
173 |
174 | Generate TypeScript types for your features. This ensures type safety when using Reflag features in your TypeScript/JavaScript applications.
175 |
176 | ```bash
177 | npx reflag features types [--app-id ap123456789] [--out gen/features.ts] [--format react]
178 | ```
179 |
180 | Options:
181 |
182 | * `--app-id`: App ID to use.
183 | * `--out`: Path to generate TypeScript types.
184 | * `--format`: Format of the generated types (react or node).
185 |
186 | ### `reflag companies`
187 |
188 | Commands for managing companies.
189 |
190 | #### `reflag companies list`
191 |
192 | List all companies in your app.
193 |
194 | ```bash
195 | npx reflag companies list [--filter <text>] [--app-id ap123456789]
196 | ```
197 |
198 | Options:
199 |
200 | * `--filter`: Filter companies by name or ID.
201 | * `--app-id`: App ID to use.
202 |
203 | The command outputs a table with the following columns:
204 |
205 | * `id`: Company ID.
206 | * `name`: Company name (shows "(unnamed)" if not set).
207 | * `users`: Number of users in the company.
208 | * `lastSeen`: Date when the company was last active.
209 |
210 | ### `reflag companies features access`
211 |
212 | Grant or revoke access to specific features for companies, segments, and users. If no feature key is provided, you'll be prompted to select one from a list.
213 |
214 | ```bash
215 | npx reflag companies features access [--app-id ap123456789] [featureKey] [--enable|--disable] [--companies <id...>] [--segments <id...>] [--users <id...>]
216 | ```
217 |
218 | Arguments:
219 |
220 | * `featureKey`: Key of the feature to grant/revoke access to (optional, interactive selection if omitted).
221 |
222 | Options:
223 |
224 | * `--enable`: Enable the feature for the specified targets.
225 | * `--disable`: Disable the feature for the specified targets.
226 | * `--users`: User IDs to target. Can be specified multiple times.
227 | * `--companies`: Company IDs to target. Can be specified multiple times.
228 | * `--segments`: Segment IDs to target. Can be specified multiple times.
229 | * `--app-id`: App ID to use.
230 |
231 | At least one target (companies, segments, or users) must be specified. You must also specify either `--enable` or `--disable`, but not both.
232 |
233 | Example:
234 |
235 | ```bash
236 | # Enable feature for multiple companies and users
237 | npx reflag companies features access my-feature --enable --companies comp_123 --companies comp_456 --users user_789
238 | ```
239 |
240 | ### `reflag apps`
241 |
242 | Commands for managing Reflag apps.
243 |
244 | ## Global Options
245 |
246 | These options can be used with any command:
247 |
248 | * `--debug`: Enable debug mode for verbose output.
249 | * `--base-url <url>`: Set the base URL for Reflag API.
250 | * `--api-url <url>`: Set the API URL directly (overrides base URL).
251 | * `--api-key <key>`: Reflag API key for non-interactive authentication.
252 | * `--help`: Display help information for a command.
253 |
254 | ## AI-Assisted Development
255 |
256 | Reflag provides powerful AI-assisted development capabilities through rules and Model Context Protocol (MCP). These features help your AI development tools better understand your features and provide more accurate assistance.
257 |
258 | ### Reflag Rules (Recommended)
259 |
260 | The `rules` command helps you set up AI-specific rules for your project. These rules enable AI tools to better understand how to work with Reflag and feature flags and how they should be used in your codebase.
261 |
262 | ```bash
263 | npx reflag rules [--format <cursor|copilot>] [--yes]
264 | ```
265 |
266 | Options:
267 |
268 | * `--format`: Format to add rules in:
269 | * `cursor`: Adds rules to `.cursor/rules/reflag.mdc` for Cursor IDE integration.
270 | * `copilot`: Adds rules to `.github/copilot-instructions.md` for GitHub Copilot integration.
271 | * `--yes`: Skip confirmation prompts and overwrite existing files without asking.
272 |
273 | This command will add rules to your project that provide AI tools with context about how to setup and use Reflag feature flags. For the copilot format, the rules will be added to a dedicated section in the file, allowing you to maintain other copilot instructions alongside Reflag's rules.
274 |
275 | ## Model Context Protocol
276 |
277 | The Model Context Protocol (MCP) is an open protocol that provides a standardized way to connect AI models to different data sources and tools. In the context of Reflag, MCP enables your code editor to understand your feature flags, their states, and their relationships within your codebase. This creates a seamless bridge between your feature management workflow and AI-powered development tools. The MCP server is hosted by Reflag, so it's very easy to get started.
278 |
279 | _**Note: The Reflag `mcp` CLI command was previously used for a \_local**_** server. However, in recent versions of the Reflag CLI, the `mcp` command has been repurposed to help you connect to the new remote MCP server.**
280 |
281 | ### Setting up MCP
282 |
283 | The `mcp` command helps you configure your editor or AI client to connect with Reflag's remote MCP server. This allows your AI tools to understand your feature flags and provide more contextual assistance.
284 |
285 | ```bash
286 | npx reflag mcp [--app-id <id>] [--editor <editor>] [--scope <local|global>]
287 | ```
288 |
289 | Options:
290 |
291 | * `--app-id`: App ID to use for the MCP connection.
292 | * `--editor`: The editor/client to configure:
293 | * `cursor`: [Cursor IDE](https://www.cursor.com/)
294 | * `vscode`: [Visual Studio Code](https://code.visualstudio.com/)
295 | * `claude`: [Claude Desktop](https://claude.ai/download)
296 | * `windsurf`: [Windsurf](https://windsurf.com/editor)
297 | * `--scope`: Whether to configure settings globally or locally for the project.
298 |
299 | The command will guide you through:
300 |
301 | 1. Selecting which editor/client to configure.
302 | 2. Choosing which Reflag app to connect to.
303 | 3. Deciding between global or project-local configuration.
304 | 4. Setting up the appropriate configuration file for your chosen editor .
305 |
306 | _**Note: The setup uses**_ [_**mcp-remote**_](https://github.com/geelen/mcp-remote) _**as a compatibility layer allowing the remote hosted Reflag MCP server to work with all editors/clients that support MCP STDIO servers. If your editor/client supports HTTP Streaming with OAuth you can connect to the Reflag MCP server directly.**_
307 |
308 | ## Using in CI/CD Pipelines (Beta)
309 |
310 | The Reflag CLI is designed to work seamlessly in CI/CD pipelines. For automated environments where interactive login is not possible, use the `--api-key` option, or specify the API key in `REFLAG_API_KEY` environment variable.
311 |
312 | ```bash
313 | # Generate types in CI/CD
314 | npx reflag apps list --api-key $REFLAG_API_KEY
315 | ```
316 |
317 | **Important restrictions:**
318 |
319 | * When using `--api-key`, the `login` and `logout` commands are disabled.
320 | * API keys bypass all interactive authentication flows.
321 | * Only _read-only_ access to Reflag API is granted at the moment.
322 | * API keys are bound to one app only. Commands such as `apps list` will only return the bound app.
323 | * Store API keys securely using your CI/CD platform's secret management.
324 |
325 | Example CI workflow:
326 |
327 | ```yaml
328 | # GitHub Actions example
329 | - name: Generate types
330 | run: npx reflag features types --api-key ${{ secrets.REFLAG_API_KEY }}
331 |
332 | # GitHub Actions example (using environment):
333 | - name: Generate types (environment)
334 | run: npx reflag features types
335 | env:
336 | REFLAG_API_KEY: ${{ secrets.REFLAG_CI_API_KEY }}
337 | ```
338 |
339 | ## Development
340 |
341 | ```bash
342 | # Build the CLI
343 | yarn build
344 |
345 | # Run the CLI locally
346 | yarn reflag [command]
347 |
348 | # Lint and format code
349 | yarn lint
350 | yarn format
351 | ```
352 |
353 | ## Requirements
354 |
355 | * Node.js >=18.0.0
356 |
357 | ## License
358 |
359 | > MIT License Copyright (c) 2025 Bucket ApS
360 |
```
.png?lines=false&page=4){kind=link}
.png?lines=true&page=4&format=md){kind=link}
.png?lines=true&page=1){kind=link}
.png?lines=true&page=3){kind=link}
.png?lines=true&page=5){kind=link}
.png?lines=true&page=7){kind=link}