@rungs/cli 0.1.0 → 0.1.2

package/README.md

@@ -14,12 +14,12 @@ then keeps checking that they still say what they said.
 $ rungs init . tracked
   instructions   3 create
   gates          1 create · 1 skill · 2 merge
-  backlog        6 create · 1 rule · 2 skill · 1 merge
+  backlog        5 create · 1 rule · 2 skill · 1 merge
   findings       1 create · 1 skill · 1 merge
   adr            2 create · 1 merge
   session        2 create · 1 skill · 1 merge
 
-  registered 18 gates from 6 module(s)
+  registered 19 gates from 6 module(s)
   rendered 2 file(s) · 0 degraded → .ai/render-report.md
 
 $ rungs check
@@ -39,8 +39,8 @@ Every rule in here was **paid for once already**.
 
 The content is extracted from four repositories built over six months in
 different stacks — a .NET ingestion platform, a 105-package Angular monorepo, a
-set of reference apps, and a full-stack product with 3,236 commits across 401
-branches. Each solved part of this by hand. Each also failed in ways the others
+set of reference apps, and a full-stack product whose refreshed candidate measured
+3,585 commits across 433 branches on 2026-08-15. Each solved part of this by hand. Each also failed in ways the others
 did too.
 
 So rungs does not ship a good idea about how to work. It ships **what four repos
@@ -58,22 +58,29 @@ so you don't install rung 5 at rung 1.
 
 ## Install
 
-Not published yet. For now:
-
 ```bash
-git clone <this repo> && cd rungs && npm install
-node src/cli.ts --help
+npx @rungs/cli doctor
 ```
 
-Requires **Node 22.18+** — it runs TypeScript directly, no build step.
+It reports what your repo already has, installed or not, and ends by naming one
+command to run next. Once you have run that:
+**[your first hour](docs/getting-started.md)** — which of the new files matter,
+what the installed skills are for, and what to do when a gate goes red.
+
+Requires **Node 22.18+**. The published package ships a bundled JavaScript entry point; the source
+checkout still runs the TypeScript sources directly with `node`.
 
-Published as **`@rungs/cli`** — the unscoped name `rungs` is unpublishable, being
-one edit away from both `rung` and `runjs`, which npm's typosquat filter refuses.
-The tool, the command and everything it writes are still `rungs`; only the
-package identifier differs:
+Published as **`@rungs/cli`**, not `rungs`: the unscoped name is unpublishable,
+being one edit from both `rung` and `runjs`, which npm's typosquat filter
+refuses. The tool, the command, and everything it writes are still `rungs` —
+only the package identifier differs. After a global install the command is
+plain `rungs`.
+
+From source:
 
 ```bash
-npx @rungs/cli doctor
+git clone https://github.com/ThroughTheWind/rungs && cd rungs && npm install
+node src/cli.ts --help
 ```
 
 ## What you get
@@ -98,7 +105,7 @@ reported as diverged and left alone.
 
 ## Commands
 
-| | |
+| Command | Description |
 | --- | --- |
 | `rungs init [path] [profile]` | Scaffold — `minimal` · `tracked` · `disciplined` · `hardened` · `fleet` |
 | `rungs doctor [path]` | What does this repo already have? Works on repos that never installed anything |
@@ -110,7 +117,19 @@ reported as diverged and left alone.
 | `rungs setup git [path]` | Install the merge drivers `.gitattributes` names |
 | `rungs modules` | List the set and audit the manifests |
 
-Add `--dry-run` to any write command.
+| Option | Effect |
+| --- | --- |
+| `--dry-run` | Report what would happen, write nothing. Any write command |
+| `--into <path>` | `add`: install into this repo rather than the working directory |
+| `--set <module>.<param>=<value>` | `add` / `init`: override a module parameter. Repeatable, and `--set m.p=v` works too |
+| `--confirm-threshold` | `add`: install a module whose rung is above this repo |
+| `--apply` | `upgrade`: write the changes rather than preview them |
+| `--fast` / `--full` | `check`: pick the gate tier, as the positional also does |
+| `--copilot` | Also emit Copilot instruction files |
+
+`rungs --help` prints the same two tables. For module parameters run `rungs
+modules --params`, which renders them from the manifests; what a parameter *is*
+and how to set one is [`docs/design/parameters.md`](docs/design/parameters.md).
 
 ## Modules
 
@@ -163,12 +182,15 @@ Four promises that shape everything else:
 
 ## Status
 
-**Pre-release, v0.1.0.** Everything above runs; nothing is published.
+**Release candidate, v0.1.1** — prepared locally as
+[`@rungs/cli`](https://www.npmjs.com/package/@rungs/cli); the public `latest` tag remains v0.1.0
+until registry credentials are available.
 
 rungs is installed in its own repo and its gates run on every change — 20 pass,
-0 fail. Detection is [verified against all four source
-repos](docs/design/detection-verification.md). Not yet done: publishing, and
-installing into a source repo for real rather than in dry run.
+0 fail (`rungs check`, 2026-08-15). A clean consumer has also installed the packed
+artifact and completed the doctor → init → add → check → render → upgrade/eject
+journey locally. Detection is [verified against all four source repos](docs/design/detection-verification.md).
+Not yet done: an install from the public registry and a cross-platform release matrix.
 
 Expect module *contents* to move. The command surface is settled.
 
@@ -183,7 +205,7 @@ nobody paid for does not ship.
 
 ## Repository
 
-| | |
+| Location | Contents |
 | --- | --- |
 | [`docs/research/`](docs/research/README.md) | The four repo autopsies, the synthesis, the pattern catalogue |
 | [`docs/design/`](docs/design/README.md) | Product brief, module catalogue, verification |