Skip to content

docs(cli): refresh README for the microkernel model #237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rqbazan merged 2 commits into from
Jun 1, 2026
Merged

docs(cli): refresh README for the microkernel model #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e5bcae
docs(cli): refresh README for the microkernel model
rqbazan Jun 1, 2026
2cb7f69
docs(cli): render the plugin list as a table
rqbazan Jun 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/cli-readme-toolbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 10 additions & 10 deletions run-run/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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/<tool>-plugin` package. Install one with:
`rr` is a microkernel: every tool lives in its own `@rrlab/<tool>-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
Expand Down
Loading