https://github.com/flagsmith/flagsmith-cli
A CLI to fetch and output your Flagsmith features to a file
https://github.com/flagsmith/flagsmith-cli
Last synced: 9 months ago
JSON representation
A CLI to fetch and output your Flagsmith features to a file
- Host: GitHub
- URL: https://github.com/flagsmith/flagsmith-cli
- Owner: Flagsmith
- License: mit
- Created: 2022-08-19T10:35:08.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-13T15:17:39.000Z (11 months ago)
- Last Synced: 2025-07-09T07:04:10.201Z (9 months ago)
- Language: TypeScript
- Size: 30.9 MB
- Stars: 5
- Watchers: 8
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
flagsmith-cli
=================
Retrieve Flagsmith state from an API and store it in a file.
This CLI can be used to bake default flags into your application as part of CI/CD, this provides support for offline applications and is also advised as part of our [Defensive Coding and Default Flags Documentation](https://docs.flagsmith.com/guides-and-examples/defensive-coding). An example of this can be seen [here](./example).
# Populating defaultFlags in your Project
The steps to using this to provide default flags are as follows. An example of this can be found [here](./example). The main steps to achieving this are as follows:
1. Install the cli ``npm i flagsmith-cli --save-dev``
2. Call the cli as part of postinstall to create a ``flagsmith.json`` file:
```export FLAGSMITH_ENVIRONMENT=API_KEY```
```
"postinstall": "flagsmith get"
```
An example of this can be seen [here](./example/src/index.tsx).
3. In your application, import the outputted JSON and initialise the client with the json ``flagsmith.init({state:json, environmentID: json.environmentID})``
**Example:**
```typescript
import flagsmith from 'flagsmith'
import state from './flagsmith.json'
flagsmith.init({state, environmentID: state.environmentID})
```
**Example with React:**
```jsx
import state from './flagsmith.json'
ReactDOM.render(
,
document.getElementById('root')
);
```
# Usage - Global
```sh-session
$ npm install -g flagsmith-cli
$ flagsmith COMMAND
running command...
$ flagsmith (--version)
flagsmith-cli/0.1.2 darwin-arm64 node-v18.13.0
$ flagsmith --help [COMMAND]
USAGE
$ flagsmith COMMAND
...
```
# Commands
* [`flagsmith get [ENVIRONMENT]`](#flagsmith-get-environment)
* [`flagsmith help [COMMANDS]`](#flagsmith-help-commands)
## `flagsmith get [ENVIRONMENT]`
Retrieve flagsmith features from the Flagsmith API and output them to a file.
```
USAGE
$ flagsmith get [ENVIRONMENT] [-o ] [-a ] [-t
-i ] [-p] [-e flags|environment]
ARGUMENTS
ENVIRONMENT The flagsmith environment key to use, defaults to the environment
variable FLAGSMITH_ENVIRONMENT
FLAGS
-a, --api= [default: https://edge.api.flagsmith.com/api/v1/] The
API URL to fetch the feature flags from
-e, --entity= [default: flags] The entity to fetch, this will either
be the flags or an environment document used for [local
evaluation](https://docs.flagsmith.com/clients/server-s
ide#local-evaluation-mode-network-behaviour).
-o, --output= [default: ./flagsmith.json] The file path output
-p, --pretty Prettify the output JSON
IDENTITY FLAGS
-i, --identity= The identity for which to fetch
feature flags
-t, --trait==... Trait key-value pair, separated by
an equals sign (=)
DESCRIPTION
Retrieve flagsmith features from the Flagsmith API and output them to a file.
EXAMPLES
$ flagsmith get
$ FLAGSMITH_ENVIRONMENT=abc123... flagsmith get
$ FLAGSMITH_ENVIRONMENT=ser.abc123... flagsmith get -e environment
$ flagsmith get -o ./my-file.json
$ flagsmith get -a https://flagsmith.example.com/api/v1/
$ flagsmith get -i flagsmith_identity
$ flagsmith get -i flagsmith_identity -t my_trait_key=some_trait_value -t other_trait=other_value
$ flagsmith get -p
```
_See code: [dist/commands/get/index.ts](https://github.com/Flagsmith/flagsmith-cli/blob/v0.1.4/dist/commands/get/index.ts)_
## `flagsmith help [COMMANDS]`
Display help for flagsmith.
```
USAGE
$ flagsmith help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for flagsmith.
```