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.
| ``` | ||
|
|
||
| Installs to `$HOME/.local/bin` and adds it to your `PATH`. Options: | ||
| We use this on ourselves. A 78-line GitHub Actions workflow in the Flagsmith repo is now one command. |
There was a problem hiding this comment.
This gives an impression that we use eval --test, which we do not.
The copy exhibits typical LLM context-deafness (who cares how many lines our workflow had?!), and is factually incorrect.
| ## 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>
2 participants
No description provided.