@rungs/cli 0.1.2 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,7 @@
1
1
  # rungs
2
2
 
3
- **Installs and maintains a repository's agentic development system.**
3
+ **rungs CLI repository infrastructure for coding agents.** It installs and
4
+ maintains a repository's agentic development system.
4
5
 
5
6
  Your agent has instructions. Do they have gates? Is your backlog's status field
6
7
  telling the truth about what actually merged? That thing you noticed last
@@ -10,6 +11,22 @@ rungs scaffolds the parts of a working setup — agent instructions, skills, wor
10
11
  tracking, findings, decision records, validation gates — as **modules you pick**,
11
12
  then keeps checking that they still say what they said.
12
13
 
14
+ **Start read-only.** `doctor` writes nothing, works on repos that never installed
15
+ anything, and ends by naming one command:
16
+
17
+ ```console
18
+ $ npx @rungs/cli doctor
19
+ ci theirs
20
+ 1× .github/workflows/*.yml e.g. .github/workflows/ci.yml
21
+
22
+ 1 present · 0 different paradigm · 14 absent
23
+
24
+ Next
25
+ rungs add ci — adopt what you already built, in place
26
+ ```
27
+
28
+ Once you have run that:
29
+
13
30
  ```console
14
31
  $ rungs init . tracked
15
32
  instructions 3 create
@@ -47,7 +64,7 @@ So rungs does not ship a good idea about how to work. It ships **what four repos
47
64
  learned, with the incident attached**. Every module declares its provenance, and
48
65
  `doctor` quotes that incident back when a gate it installed has never fired:
49
66
 
50
- > `check-findings-register` has run 340 times and never fired. It exists because
67
+ > `audit-output-is-rows` has run 340 times and never fired. It exists because
51
68
  > one repo produced 268 audit reports with no register to close them into. Is
52
69
  > that still a risk here — or is this gate scoped too narrowly?
53
70
 
@@ -67,6 +84,9 @@ command to run next. Once you have run that:
67
84
  **[your first hour](docs/getting-started.md)** — which of the new files matter,
68
85
  what the installed skills are for, and what to do when a gate goes red.
69
86
 
87
+ New to the vocabulary? **[The nine words this page uses](docs/glossary.md)**,
88
+ defined once each.
89
+
70
90
  Requires **Node 22.18+**. The published package ships a bundled JavaScript entry point; the source
71
91
  checkout still runs the TypeScript sources directly with `node`.
72
92
 
@@ -109,6 +129,7 @@ reported as diverged and left alone.
109
129
  | --- | --- |
110
130
  | `rungs init [path] [profile]` | Scaffold — `minimal` · `tracked` · `disciplined` · `hardened` · `fleet` |
111
131
  | `rungs doctor [path]` | What does this repo already have? Works on repos that never installed anything |
132
+ | `rungs doctor --explain` | Also run the detectors over what it found — evidence rows, never a score |
112
133
  | `rungs add <module…>` | Install one module, resolving dependencies and adopting what exists |
113
134
  | `rungs check [path]` | Run the gates, record the ledger |
114
135
  | `rungs render [path]` | Re-emit path-scoped rules for each harness |
@@ -116,13 +137,16 @@ reported as diverged and left alone.
116
137
  | `rungs eject [path]` | Materialise the engines; stop depending on rungs |
117
138
  | `rungs setup git [path]` | Install the merge drivers `.gitattributes` names |
118
139
  | `rungs modules` | List the set and audit the manifests |
140
+ | `rungs backlog archive` | Move finished items to `archive/`, repointing every link that cites them |
119
141
 
120
142
  | Option | Effect |
121
143
  | --- | --- |
122
144
  | `--dry-run` | Report what would happen, write nothing. Any write command |
145
+ | `--explain` | `doctor`: run the detectors too. Read-only, and it runs no command your repo owns |
123
146
  | `--into <path>` | `add`: install into this repo rather than the working directory |
124
147
  | `--set <module>.<param>=<value>` | `add` / `init`: override a module parameter. Repeatable, and `--set m.p=v` works too |
125
148
  | `--confirm-threshold` | `add`: install a module whose rung is above this repo |
149
+ | `--confirm-paradigm` | `add`: install a module this repo already solves another way |
126
150
  | `--apply` | `upgrade`: write the changes rather than preview them |
127
151
  | `--fast` / `--full` | `check`: pick the gate tier, as the positional also does |
128
152
  | `--copilot` | Also emit Copilot instruction files |
@@ -153,6 +177,12 @@ Full specification: [`docs/design/module-catalog.md`](docs/design/module-catalog
153
177
 
154
178
  ## Which agents
155
179
 
180
+ **Bring your own.** rungs is not a methodology and not an orchestrator: it does
181
+ not decide how your agent plans, specifies, or executes. It checks that the
182
+ repository underneath stays coherent while it does — which is why it composes
183
+ with whatever harness or spec-driven process you already run rather than
184
+ replacing one. `AGENTS.md` is embraced, not competed with.
185
+
156
186
  Skills are **spec-compliant Agent Skills**, portable to Claude Code, Codex,
157
187
  Cursor, Copilot, Gemini CLI and 40+ others without translation.
158
188
 
@@ -182,12 +212,19 @@ Four promises that shape everything else:
182
212
 
183
213
  ## Status
184
214
 
185
- **Release candidate, v0.1.1** — prepared locally as
186
- [`@rungs/cli`](https://www.npmjs.com/package/@rungs/cli); the public `latest` tag remains v0.1.0
187
- until registry credentials are available.
215
+ **Next release: v0.2.0** — assembled from [`changelog.d/0.2.0.md`](changelog.d/0.2.0.md) and
216
+ prepared in [`package.json`](package.json), untagged until the
217
+ [release runbook](docs/design/release-runbook.md) is run to completion. That number is checked
218
+ against the manifest by the `docs-version-claims` gate, so this sentence cannot drift from what
219
+ ships.
220
+
221
+ What is **published** is deliberately not restated here. It lives on
222
+ [the versions page](https://docs.rungscli.com/versions/), which is the one place that tracks it —
223
+ this file and the roadmap both carried their own copy and both said `v0.1.2` for two days after
224
+ v0.1.3 went to npm.
188
225
 
189
- rungs is installed in its own repo and its gates run on every change — 20 pass,
190
- 0 fail (`rungs check`, 2026-08-15). A clean consumer has also installed the packed
226
+ rungs is installed in its own repo and its gates run on every change — 25 pass,
227
+ 0 fail (`rungs check`, 2026-08-17). A clean consumer has also installed the packed
191
228
  artifact and completed the doctor → init → add → check → render → upgrade/eject
192
229
  journey locally. Detection is [verified against all four source repos](docs/design/detection-verification.md).
193
230
  Not yet done: an install from the public registry and a cross-platform release matrix.
@@ -211,7 +248,7 @@ nobody paid for does not ship.
211
248
  | [`docs/design/`](docs/design/README.md) | Product brief, module catalogue, verification |
212
249
  | [`docs/decisions/`](docs/decisions/README.md) | ADRs |
213
250
  | [`modules/`](modules/README.md) | The fifteen modules |
214
- | [`src/`](src/) | The CLI, ~2,800 lines |
251
+ | [`src/`](src/) | The CLI, ~4,700 lines (`wc -l src/*.ts`, 2026-08-17; held within 10% by `docs-version-claims`) |
215
252
 
216
253
  ## Licence
217
254