Skip to content

Commit f87de34

Browse files
committed
docs: refresh the README install instructions
Point installs at get.flagsmith.com rather than a raw.githubusercontent.com path, add the npm package, and open with what the CLI is for instead of calling it a work in progress. The pinned --version example is wrapped in release-please block markers so it bumps with every release like the ones in install.sh and install.ps1. It needs the block form rather than an inline annotation because the line sits inside a fenced code block, where the comment would render as part of the snippet.
1 parent 4d77127 commit f87de34

1 file changed

Lines changed: 17 additions & 7 deletions

File tree

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Flagsmith CLI
22

3-
The next-generation Flagsmith command-line interface (work in progress).
3+
The Flagsmith command-line interface helps you manage and roll out your feature flags without leaving your terminal.
44

55
## Install
66

@@ -11,28 +11,38 @@ brew install Flagsmith/tap/flagsmith
1111
Or:
1212

1313
```sh
14-
curl -fsSL https://raw.githubusercontent.com/Flagsmith/flagsmith-cli/main/install.sh | sh
14+
curl -fsSL https://get.flagsmith.com | sh
1515
```
1616

1717
Installs to `$HOME/.local/bin` and adds it to your `PATH`. Options:
1818

19+
<!-- x-release-please-start-version -->
20+
1921
```sh
20-
curl -fsSL https://raw.githubusercontent.com/Flagsmith/flagsmith-cli/main/install.sh | sh -s -- --version v2.0.0 --bin-dir /usr/local/bin --no-modify-path
21-
curl -fsSL https://raw.githubusercontent.com/Flagsmith/flagsmith-cli/main/install.sh | sh -s -- --help
22+
curl -fsSL https://get.flagsmith.com | sh -s -- --version v2.0.0-beta.3 --bin-dir /usr/local/bin --no-modify-path
23+
curl -fsSL https://get.flagsmith.com | sh -s -- --help
2224
```
2325

26+
<!-- x-release-please-end -->
27+
2428
`FLAGSMITH_CLI_VERSION`, `FLAGSMITH_INSTALL_DIR` and `FLAGSMITH_NO_MODIFY_PATH` do the same if exported first.
2529

2630
To pin the installer itself, fetch it at a commit you trust: `raw.githubusercontent.com/Flagsmith/flagsmith-cli/<sha>/install.sh`.
2731

28-
Alternatively, `go install github.com/Flagsmith/flagsmith-cli/v2@v2.0.0-beta.3` (installs as `flagsmith-cli`), or grab an archive from [Releases](https://github.com/Flagsmith/flagsmith-cli/releases). <!-- x-release-please-version -->
29-
3032
On Windows:
3133

3234
```powershell
3335
irm https://raw.githubusercontent.com/Flagsmith/flagsmith-cli/main/install.ps1 | iex
3436
```
3537

38+
Using npm:
39+
40+
```sh
41+
npm install -g @flagsmith/cli
42+
```
43+
44+
Alternatively, `go install github.com/Flagsmith/flagsmith-cli/v2@v2.0.0-beta.3` (installs as `flagsmith-cli`), or grab an archive from [Releases](https://github.com/Flagsmith/flagsmith-cli/releases). <!-- x-release-please-version -->
45+
3646
## Build
3747

3848
```sh
@@ -56,7 +66,7 @@ flagsmith flag list # list the flags in the current environment
5666

5767
## Commands
5868

59-
Full reference for every command and flag: <https://flagsmith.github.io/flagsmith-cli/> (generated from `--help`, so it matches the release).
69+
Full reference for every command and flag: <https://flagsmith.github.io/flagsmith-cli/>.
6070

6171
Reading works against any Flagsmith instance. Changing flags — `flag update`, `flag enable`/`disable`, `flag reorder`, `flag delete` — needs Flagsmith 2.263.0 or newer, self-hosted or SaaS.
6272

0 commit comments

Comments
 (0)