Updated README and adding an example AGENTS.md file - #94
Conversation
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
|
||
| [](https://github.com/Flagsmith/flagsmith-cli/releases) [](./LICENSE) | ||
|
|
||
| --- |
There was a problem hiding this comment.
I'd prefer a heading here instead of a divider.
|
|
||
| ```sh | ||
| brew install Flagsmith/tap/flagsmith | ||
| ## Stop a release that depends on a flag that's off |
There was a problem hiding this comment.
If this section gains an H2 heading, these become H3 and don't read as noisy as they do now.
Ideally, they shouldn't be headings at all. Landing page layouts don't really work well in documentation.
| ## Which Flagsmith CLI is this? | ||
|
|
||
| There are two, and they do different jobs. | ||
|
|
||
| | | `flagsmith-cli` (npm) | `flagsmith` (this one) | | ||
| |---|---|---| | ||
| | **What it's for** | Fetching flag state at build time and writing it to a file | Managing your Flagsmith account, and gating pipelines | | ||
| | **Reads / writes** | Read-only | Read and write | | ||
| | **Installed with** | npm | curl, PowerShell, Docker, `go install` | | ||
| | **Needs** | Node | Nothing | | ||
|
|
||
| **Already using the npm package?** Keep using it — it still works and we'll give notice before that changes. When you want to consolidate, this CLI covers the same ground: | ||
|
|
||
| ```bash | ||
| flagsmith evaluate --js # the state a frontend SDK hydrates from | ||
| flagsmith environment document # the local-evaluation environment document | ||
| ``` | ||
|
|
||
| This tool is version 2 because it shares a repository and a name with the older one. It is not an upgrade of it. |
There was a problem hiding this comment.
This really should be a simple deprecation notice / migration guide. Instead, it confuses people, and their agents:
It is not an upgrade of it.
It very much is. It's a replacement!
|
|
||
| - Documentation: [docs.flagsmith.com](https://docs.flagsmith.com/integrating-with-flagsmith/CLI) | ||
| - Bugs and requests: [open an issue](https://github.com/Flagsmith/flagsmith-cli/issues) | ||
| - Include `flagsmith --version` and how you installed it |
There was a problem hiding this comment.
Can we add an issue template instead?
There was a problem hiding this comment.
not sure what that exactly means, can you show me an example?
There was a problem hiding this comment.
Co-authored-by: Kim Gustyr <kim.gustyr@flagsmith.com>
Co-authored-by: Kim Gustyr <kim.gustyr@flagsmith.com>
Co-authored-by: Kim Gustyr <kim.gustyr@flagsmith.com>
| ## Docker | ||
| ## Using it with a coding agent | ||
|
|
||
| The CLI is a smaller context cost than a full tool catalogue: your agent gets one binary with self-documenting help, and pays for it only when it runs something. |
There was a problem hiding this comment.
The CLI is a smaller context cost than a full tool catalogue
context?
| ```sh | ||
| flagsmith init # log in, pick a project + environment, write flagsmith.json | ||
| flagsmith flag list # list the flags in the current environment | ||
| ## Command reference |
There was a problem hiding this comment.
The CLI docs over at docs.flagsmith.com reference #commands, let's change this heading back:
| ## Command reference | |
| ## Commands |
| Self-hosted? Point at your own instance with `--api-url` or `FLAGSMITH_API_URL`: | ||
|
|
||
| ```bash | ||
| flagsmith --api-url https://flagsmith.internal/api/v1 flag list | ||
| ``` |
There was a problem hiding this comment.
we need to add info on host-scoped static credentials here
| The next-generation Flagsmith command-line interface (work in progress). | ||
| Manage Flagsmith from your terminal and your pipeline. | ||
|
|
||
| ## Install |
There was a problem hiding this comment.
The CLI docs over at docs.flagsmith.com reference #install. we should keep the Install heading, or change that reference in Flagsmith/flagsmith#8045.
| ```powershell | ||
| irm https://raw.githubusercontent.com/Flagsmith/flagsmith-cli/main/install.ps1 | iex | ||
| irm https://get.flagsmith.com/install.ps1 | iex | ||
| ``` |
There was a problem hiding this comment.
homebrew instruction got swallowed in a merge conflict. we'll also have an npm instruction soon
| curl -sSL https://get.flagsmith.com | sh | ||
| flagsmith init | ||
|
|
||
| [](https://github.com/Flagsmith/flagsmith-cli/releases) [](./LICENSE) |
There was a problem hiding this comment.
The ```bash fence opened above is never closed, so the badges line and the whole rest of the README get swallowed into the code block. Needs a closing fence before the badges.
| Installs to `$HOME/.local/bin` and adds it to your `PATH`. Options: | ||
| Writes a `flagsmith.json` you commit with your code, recording which project and environment this repo maps to. New teammates can clone, log in, and they're pointed at the right project. Prevents complex setup docs and changes landing in the wrong environment. | ||
|
|
||
| If you work across several projects, this is even more uesful, both for you and for LLMs interacting on your behalf. |
2 participants
No description provided.