diff --git a/.changeset/cli-readme-toolbox.md b/.changeset/cli-readme-toolbox.md new file mode 100644 index 0000000..167c50a --- /dev/null +++ b/.changeset/cli-readme-toolbox.md @@ -0,0 +1,7 @@ +--- +"@rrlab/cli": patch +--- + +Refresh the README for the microkernel model. + +Drop the stale, hand-maintained `Toolbox` section (it still listed `rimraf`, which isn't a plugin) and fold the tool list into the `Plugins` section as the single source of truth. The official plugins are now named there — `biome`, `oxc`, `ts`, `tsdown` — each linked to the tool it wraps, framed as capabilities added via plugins rather than a flat bag of tools. diff --git a/run-run/cli/README.md b/run-run/cli/README.md index 51c2e68..e771e98 100644 --- a/run-run/cli/README.md +++ b/run-run/cli/README.md @@ -6,15 +6,6 @@ CLI toolbox to fullstack common scripts in [Variable Land](https://variable.land - Node.js >= 20.0.0 -## Toolbox - -- [biome](https://biomejs.dev) -- [tsc](https://www.typescriptlang.org) -- [rimraf](https://www.npmjs.com/package/rimraf) -- [oxfmt](https://oxc.rs/docs/guide/usage/formatter.html) -- [oxlint](https://oxc.rs/docs/guide/usage/linter.html) -- [tsdown](https://tsdown.dev) - ## Installation ```sh @@ -37,7 +28,16 @@ See [`CLI.md`](./CLI.md) for the full reference (auto-generated per release). ## Plugins -`rr` is a microkernel: every tool (Biome, TypeScript, tsdown, …) lives in its own `@rrlab/-plugin` package. Install one with: +`rr` is a microkernel: every tool lives in its own `@rrlab/-plugin` package. The official plugins are: + +| Plugin | Wraps | Install | +| -------- | -------------------------------------------------------------------------------------------------------------- | ------------------------ | +| `biome` | [Biome](https://biomejs.dev) | `rr plugins add biome` | +| `oxc` | [oxlint](https://oxc.rs/docs/guide/usage/linter.html) + [oxfmt](https://oxc.rs/docs/guide/usage/formatter.html) | `rr plugins add oxc` | +| `ts` | [tsc](https://www.typescriptlang.org) | `rr plugins add ts` | +| `tsdown` | [tsdown](https://tsdown.dev) | `rr plugins add tsdown` | + +Install one with: ```sh rr plugins add biome