@theholocron/cli 5.0.0-alpha.35 → 5.0.0-alpha.351

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
@@ -17,39 +17,122 @@ holocron --help
17
17
  ## Interactive mode
18
18
 
19
19
  Run `holocron` with no command, a parent command with no subcommand
20
- (`holocron auth`, `holocron skills`, `holocron upgrade`), or a leaf command
21
- missing a required positional (`holocron deploy`, `holocron secret set`), and
22
- you get a prompt instead of a `--help` dead end:
20
+ (`holocron auth`, `holocron repo`, `holocron repo upgrade`, …), or a leaf command
21
+ missing a required positional (`holocron deploy`, `holocron secrets set`), and
22
+ you get a prompt instead of a `--help` dead end.
23
+
24
+ The menu mirrors the command tree: each level shows only the next word, and a
25
+ group (marked `›`) opens its own submenu, as deep as the commands nest. Nothing
26
+ is shown as a `<command> <subcommand>` path — `config show` is `config ›` then
27
+ `show`. Every submenu has a `← back` item, and a command that is also a group
28
+ (`repo sync`, `deploy`) has a `(run it)` item at the top of its submenu. Typing
29
+ searches the whole tree — `upgrade` at the top finds the `repo` group — with
30
+ name matches ranked above description matches.
31
+
32
+ ```console
33
+ $ holocron
34
+ ? What would you like to do? › repo
35
+ ❯ repo ›
36
+ ? repo — choose a subcommand: › upgrade
37
+ ? repo upgrade — choose a subcommand: › node
38
+ ? Target Node.js major version: › 24
39
+ ```
40
+
41
+ For a command that declares options (so far: `package publish` — more are
42
+ rolled out one command group at a time), it also offers those: any required
43
+ option is prompted like a positional, and everything else goes through one
44
+ "Set any options?" checkbox, prompting only what you picked:
23
45
 
46
+ ```console
47
+ ? Set any options? (space to select, enter to skip) › ◉ npm dist-tag ◯ One-time password (2FA)
48
+ ? npm dist-tag (blank = latest): › beta
24
49
  ```
25
- $ holocron
26
- ? What would you like to do? › dep
27
- ────────────────────────────────────────────────
28
- ❯ deploy Trigger a deployment via the configured `deployment` capability
29
50
 
30
- ? Branch to deploy: › main
51
+ `package publish` specifically has three workflows that don't mix — a
52
+ steady-state publish, a one-shot `--initial` bootstrap, and a `--sync-trust`
53
+ maintenance run — so it asks which one first, then only offers that
54
+ workflow's own options; nothing from a different workflow is ever shown:
55
+
56
+ ```console
57
+ ? What would you like to do? › Initial publish (--initial)
58
+ ? Set any options? (space to select, enter to skip) › ◉ One-time password (2FA)
59
+ ...dry-run output...
60
+ ? Dry run complete — proceed with the real run? › yes
61
+ ? One-time password (2FA), if npm requires it for this publish: › ***
31
62
  ```
32
63
 
64
+ Each workflow's label ends with its real flag in parentheses when it has
65
+ one, and a longer caveat ("use only for a package's very first publish")
66
+ shows as helper text under the highlighted choice rather than bloating the
67
+ label itself.
68
+
69
+ A secret option (`--otp`) is masked as you type and delivered to the spawned
70
+ command through its environment, never its argv — `ps` and shell history
71
+ both expose a child's argv, never its env. A time-sensitive one like `--otp`
72
+ is checked off early but not actually typed until right before the real run
73
+ — after the dry-run preview and the "proceed?" question, never before —
74
+ since a dry run never checks it anyway and a code typed any earlier risks
75
+ going stale while something else is still being answered.
76
+
77
+ Whether an option is _checkbox-optional vs. always included_ and _collected
78
+ upfront vs. collected last_ are independent choices. `package publish`'s
79
+ `--otp` is always collected last, but whether it's checkbox-optional depends
80
+ on `HOLOCRON_NPM_ENFORCE_2FA`: unset (the default), it's opt-in like any other
81
+ checkbox pick; set in your own shell profile (never checked into the repo),
82
+ it's always included — for an operator whose own npm account enforces 2FA
83
+ on every publish, so the box doesn't need re-checking every single run.
84
+ Setting it has no effect on anyone else publishing from the same repo.
85
+
33
86
  The picked command spawns as a normal `holocron <command> …` invocation —
34
87
  `--token`, `--org`, `--cwd`, and `--dry-run` on the original invocation carry
35
88
  through. A non-interactive shell (CI, a script, a pipe) gets the old
36
89
  hard-failure message instead of hanging on a prompt.
37
90
 
91
+ For a command whose handler honours `--dry-run` (most of them — everything
92
+ except `auth *` and `config show`), the menu always previews it first — a
93
+ dry run doesn't mutate anything, so there's nothing to ask permission for —
94
+ then asks the one real decision:
95
+
96
+ ```console
97
+ ...dry-run output...
98
+ ? Dry run complete — proceed with the real run? › yes
99
+ ```
100
+
101
+ A preview that reports nothing would actually change (e.g. `clone` finding
102
+ every repo already cloned) skips that question too — there'd be nothing for
103
+ the real run to do either. `--skip-dry-run` opts out of the preview
104
+ entirely, straight to the real run, for when you already know what you want.
105
+
38
106
  ## Execution contexts
39
107
 
40
108
  Every command is tagged with how much of a repo it needs:
41
109
 
42
- | Context | Needs | Examples |
43
- | ------------ | -------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
44
- | `global` | just the CLI binary | `version`, `clone`, `new`, `upgrade node`, `auth set` / `check`, `plugin create`, `skills …` |
45
- | `repo-aware` | `./holocron.config` in cwd, no plugins | `run`, `ci`, `config show`, `sync-readme` |
46
- | `workspace` | the `@theholocron/holocron-plugin-*` packages resolvable | `doctor`, `setup`, `sync`, `secrets sync`, `deploy` |
110
+ | Context | Needs | Examples |
111
+ | ------------ | -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
112
+ | `global` | the CLI binary alone | `version`, `clone`, `new repo` / `plugin`, `repo upgrade …`, `auth set` / `check`, `package …`, `run lint commit-msg`, `skills …` |
113
+ | `repo-aware` | `./holocron.config`, walking up from cwd, no plugins | `run`, `run ci`, `config show`, `repo sync readme`, `deploy on-release` |
114
+ | `workspace` | the `@theholocron/holocron-plugin-*` packages resolvable | `doctor`, `repo setup`, `repo sync`, `repo cleanup branches`, `secrets …`, `deploy`, `sync github` |
47
115
 
48
116
  A `workspace` command run from a bare global install (no plugins next to the
49
117
  CLI) fails with one actionable line — install the plugins as devDependencies or
50
118
  use `pnpm exec holocron <cmd>`. `auth check` degrades to "token present,
51
119
  verification skipped" instead. `holocron --help` prints the grouping; see
52
- [Execution Contexts](https://theholocron.github.io/holocron/execution-contexts).
120
+ [Execution Contexts](https://docs.theholocron.dev/holocron/execution-contexts).
121
+
122
+ ### Viewing the resolved config
123
+
124
+ `holocron config show` prints the resolved config. On a TTY it opens a foldable
125
+ tree by default; piped or redirected, it always emits plain, valid JSON
126
+ (`holocron config show | jq`).
127
+
128
+ ```console
129
+ holocron config show # TTY: foldable tree (↑↓ move, →/⏎ expand, ← collapse, E/C all, q quit)
130
+ holocron config show --depth 2 # static coloured tree, anything nested deeper than 2 levels collapsed
131
+ holocron config show --no-interactive # static coloured tree, fully expanded
132
+ ```
133
+
134
+ Passing `--interactive` explicitly needs a TTY on stdin and stdout and fails
135
+ with a one-line message otherwise; the default falls back to static output. It has no extra dependencies — nothing to install.
53
136
 
54
137
  ## Config file
55
138
 
@@ -101,20 +184,75 @@ in at load time:
101
184
  A minimal config — for repos with a `package.json` and a GitHub remote
102
185
  — only needs `providers`:
103
186
 
187
+ ### The `.holocron/` directory
188
+
189
+ A big declaration can live in a file next to the config instead of inline, so `holocron.config.ts` stays a short index
190
+ of choices. `.holocron/<area>.{ts,js,mjs,cjs,json}` is read by name, and the areas are a closed list (a file not on
191
+ the list is never read):
192
+
193
+ | File | Where it lands |
194
+ | --------------------------- | ---------------------------------------------------------------------------------- |
195
+ | `.holocron/notifications.*` | the `layout` option of the `providers.notifications` entry (which keeps `guildId`) |
196
+ | `.holocron/repo.*` | keys of `repo` (`defaultBranch` stays inline: Sentinel needs it first) |
197
+
198
+ The file's default export is the value (`.ts` keeps its comments; `.json` needs no `import`, for repos with no
199
+ `package.json`). If both exist for one area, `.ts` wins over `.json`. A missing directory changes nothing. Setting the
200
+ same thing inline and in a file is an error that names both (`the notifications layout is set in providers.notifications
201
+ and in .holocron/notifications.ts`, `repo.topics is set in the config and in .holocron/repo.json`): there is no merge and
202
+ no precedence. An area file may `import` a sibling in `.holocron/`. Never put a secret in the directory: it is public in
203
+ a public repo.
204
+
205
+ To type the layout, import the type and use `satisfies` (there is no `defineLayout()` helper; the type-only import keeps
206
+ runtime code out of a file Sentinel evaluates from the default branch):
207
+
208
+ ```ts
209
+ import type { NotificationsLayout } from "@theholocron/cli";
210
+
211
+ export default {
212
+ // comments stay
213
+ testChannel: "holonet",
214
+ } satisfies NotificationsLayout;
215
+ ```
216
+
217
+ This repo's own Discord layout lives in `.holocron/notifications.ts`; `holocron.config.ts` keeps only `guildId`.
218
+
219
+ `RULES.md` and the webhook avatar live in `.holocron/` too (`.holocron/pinned/rules.md`, `.holocron/media/webhook-avatar.png`),
220
+ but they are not areas: the layout names them with an explicit repo-relative path (`pinned: [{ channel, file }]`,
221
+ `webhookAvatar`). `.holocron/projects/<name>.json` is the project-board template folder (SPEC-0020), read by its own
222
+ default and not placed into the config.
223
+
224
+ **Sentinel** reads the directory too, so its PR config check, property sync and role sync see the same merged config as
225
+ the CLI. It lists `.holocron/` at the config's ref and fetches the whole tree (any depth, so an area may import a
226
+ sibling), within caps: 50 files, 100 KB per file, 512 KB in all. Past a cap, or on an area file that does not load,
227
+ the check reports a load error. Only what the config or an area file imports is evaluated. The design and the decisions
228
+ are in `docs/wiki/specifications/tech-holocron-directory.spec.md` (SPEC-0069).
229
+
230
+ **Keys that never move out of `holocron.config.ts`.** `repo.defaultBranch`, because the config is the one file read
231
+ before the directory, and the default branch is what says which branch holds `.holocron/` and the config. Every other
232
+ top-level key (`name`, `org`, `domain`, `providers`, `tasks`) also stays, but only because the closed list of areas has
233
+ no entry for it: Sentinel's `validateConfig()` reads none of them before it fetches `.holocron/` (it needs the config
234
+ file's path and the `ref`, nothing from inside it). Keys that a preset spreads into `repo` (`protection`, `properties`,
235
+ which `syncPropertiesFromConfig()` reads) stay inline too, since a key set both inline and in the file is an error. There
236
+ is no per-key precedence: the loader does not let an inline key win, it refuses the duplicate and names both places. This
237
+ repo's `.holocron/repo.ts` holds `teams`, `topics`, `variables` and `secrets`, names and identifiers only, typed with
238
+ `satisfies RepoConfig` (a type-only import).
239
+
104
240
  ### repo options
105
241
 
106
- Additional `repo` fields recognised by `holocron setup`:
242
+ Additional `repo` fields recognised by `holocron repo setup`:
107
243
 
108
- | Field | Type | Description |
109
- | ----------------- | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
110
- | `repo.teams` | `Array<string \| { slug, permission }>` | GitHub teams granted repo access. String shorthand defaults to `push` (Write). `holocron setup` also writes `.github/CODEOWNERS` for teams with `push`/`maintain`/`admin`. |
111
- | `repo.topics` | `string[]` | GitHub topics set on the repository. |
112
- | `repo.protection` | `"balanced" \| "strict" \| "none"` | Branch-protection preset applied by `holocron setup`. For `"strict"`, the required status checks are derived from the task manifest — see below. |
113
- | `repo.properties` | `RepoProperties` | Org-level custom property values synced to the GitHub dashboard. |
244
+ | Field | Type | Description |
245
+ | ----------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
246
+ | `repo.teams` | `Array<string \| { slug, permission }>` | GitHub teams granted repo access. String shorthand defaults to `push` (Write). `holocron repo setup` also writes `.github/CODEOWNERS` for teams with `push`/`maintain`/`admin`. |
247
+ | `repo.topics` | `string[]` | GitHub topics set on the repository. |
248
+ | `repo.protection` | `"balanced" \| "strict" \| "none"` | Branch-protection preset applied by `holocron repo setup`. For `"strict"`, the required status checks are derived from the task manifest — see below. |
249
+ | `repo.properties` | `RepoProperties` | Org-level custom property values synced to the GitHub dashboard. |
250
+ | `repo.variables` | `{ repo?, org?, prune? }` | GitHub Actions variables created and updated by `holocron repo setup`. Undeclared ones are left alone unless `prune` is on. |
251
+ | `repo.secrets` | `{ repo?, org?, environments?, sync? }` | Names of the secrets that must exist, checked (never written) by `holocron doctor secrets`. Names only. The notification layout's secrets and a Chromatic project token are expected without being listed. `sync: [{ environment, keys?, scope? }]` declares the vault environments `secrets sync` fills from (it follows these entries, one step per scope, unless `--github-secret` is given; a blank value is skipped); the doctor expects their keys (every key the `vault` provider lists when `keys` is omitted, names only) at the `scope` (`repo`, `env=<name>`, `org=<name>`). |
114
252
 
115
253
  ### Custom properties synced to GitHub
116
254
 
117
- `holocron setup` and `holocron sync` both call `syncProperties()` with two
255
+ `holocron repo setup` and `holocron repo sync` both call `syncProperties()` with two
118
256
  kinds of fields — always one-way (`holocron.config.ts` → resolved →
119
257
  properties; properties are never a second editable source of truth):
120
258
 
@@ -139,7 +277,7 @@ properties; properties are never a second editable source of truth):
139
277
  | `holocron_compliance` | `"compliant" \| "non-compliant"` against a minimal `source` + `ci` baseline |
140
278
 
141
279
  Field definitions and derivation heuristics:
142
- `.notes/tech-holocron-platform.spec.md` → "Custom-properties sync — field
280
+ `docs/wiki/specifications/tech-holocron-platform.spec.md` → "Custom-properties sync — field
143
281
  definitions (#677)".
144
282
 
145
283
  The four derived fields' pure computation —
@@ -160,20 +298,27 @@ posts, instead of reporting pass/fail.
160
298
 
161
299
  ### Required status checks (`protection: "strict"`)
162
300
 
163
- `holocron setup` builds the branch-protection required-check list from the
301
+ `holocron repo setup` builds the branch-protection required-check list from the
164
302
  manifest, not a hand-maintained array:
165
303
 
166
- - `"DCO"` (hard-prepended), then
304
+ In the repo that holds the reusable workflows (holocron itself) the list is `ci / Required checks` and `DCO`. That is the aggregate
305
+ check (`ci/workflows/ci.yml`, written by `repo setup` / `repo sync` as `.github/workflows/ci.ci.yml`): it waits on
306
+ every `{ required: true }` task, the hand-written checks in `extraRequiredChecks` and its `codecov/*` statuses, and its
307
+ job summary lists each of them with a link, failing ones first. `DCO` stays its own required context. In any other
308
+ repo, which has no `ci` caller yet, the list is:
309
+
310
+ - `"DCO"`, then
167
311
  - every `{ required: true }` task's workflow check context (`Lint / Conclusion`,
168
- `Test / Conclusion`, `Typecheck / Conclusion`, `audit / Conclusion`), walked
312
+ `Test / Conclusion`, `Typecheck / Conclusion` while the repo is on the frozen reusables; `test:unit / Conclusion`,
313
+ `typecheck / Run tsc --noEmit`, … once it moves to the flat ones), walked
169
314
  in CI order, then
170
315
  - the top-level `extraRequiredChecks` (codecov gates, a bundle-build check, …).
171
316
 
172
317
  ```ts
173
318
  export default defineConfig({
174
319
  tasks: [
175
- { name: "lint", required: true },
176
- { name: "test", required: true },
320
+ { name: "lint:code", required: true },
321
+ { name: "test:unit", required: true },
177
322
  { name: "typecheck", required: true },
178
323
  ],
179
324
  extraRequiredChecks: ["codecov/patch", "codecov/project"],
@@ -186,11 +331,45 @@ The generated ruleset also sets `require_extra_approval_for_unattributed_changes
186
331
  false` — with `required_approving_review_count: 0` and a single maintainer, the
187
332
  GitHub default (`true`) is an unsatisfiable block on any PR with an
188
333
  unverified/unattributed commit. Repository-admin bypass still covers the real
189
- risk. And the `codecov.yml` `holocron setup` writes carries `if_not_found:
334
+ risk. And the `codecov.yml` `holocron repo setup` writes carries `if_not_found:
190
335
  success` on every status default, so an infra-only PR (dep bump, config,
191
336
  lockfile — no coverable change) passes instead of hanging on a `codecov/*`
192
- required check that never posts. A re-run of `holocron setup` backfills both into
193
- an existing repo.
337
+ required check that never posts. It also ignores `**/*.mdx`, so a docs-only PR that
338
+ adds pages is not judged to change testable files and left with an empty upload.
339
+ A re-run of `holocron repo setup` backfills all of these into an existing repo.
340
+
341
+ ### Default branch (`repo.defaultBranch`)
342
+
343
+ ```ts
344
+ export default defineConfig({
345
+ repo: { protection: "strict", defaultBranch: "alpha" },
346
+ providers: { source: "github" },
347
+ });
348
+ ```
349
+
350
+ `holocron repo setup` syncs GitHub's repo-level default branch (`HEAD`) — what a
351
+ fresh clone checks out, what `gh pr create`/the compare UI target by default,
352
+ and what Sentinel's `validateConfig()` reads (it only ever reads config from
353
+ the repo's default branch, never a PR ref — a deliberate security boundary).
354
+ Omit this field to leave GitHub's current setting untouched; most repos never
355
+ need it. It exists for a repo using a `main`/`alpha` prerelease-channel split
356
+ where active development happens on a non-`main` branch: set this to that
357
+ branch so Sentinel validates against what's actually being developed, then
358
+ change it back once that branch merges to `main` for a stable cut and stops
359
+ being the active branch.
360
+
361
+ ### Doc-comment coverage
362
+
363
+ ```ts
364
+ export default defineConfig({
365
+ repoValidation: { docsCoverage: "required" }, // "off" (default) | "warn" | "required"
366
+ });
367
+ ```
368
+
369
+ Controls `holocron probe docs patch` (skipped, reports without failing, or fails for an export a PR adds or changes
370
+ without a doc comment) and whether `holocron repo setup` adds the `documentation` flag and its statuses to
371
+ `codecov.yml`, informational for `"warn"`. It never touches the required checks. See the
372
+ [config docs](https://docs.theholocron.dev/holocron/config/#doc-comment-coverage).
194
373
 
195
374
  ### Git hooks
196
375
 
@@ -202,7 +381,7 @@ export default defineConfig({
202
381
  });
203
382
  ```
204
383
 
205
- `holocron setup` writes `.husky/pre-push` (runs `holocron ci` before every
384
+ `holocron repo setup` writes `.husky/pre-push` (runs `holocron run ci` before every
206
385
  push) and `.husky/pre-commit` (runs `gitleaks protect --staged` + `lint-staged`
207
386
  before every commit — scoped to staged changes, not the whole history, so a
208
387
  past false positive can't permanently block future commits) and sets
@@ -213,20 +392,22 @@ setup --hooks` / `--no-hooks` override per run. Bypass one push with `git push
213
392
 
214
393
  ### Task scripts
215
394
 
216
- `holocron sync` reconciles `package.json#scripts` from the `tasks` manifest
395
+ `holocron repo sync` reconciles `package.json#scripts` from the `tasks` manifest
217
396
  (merge, never clobber — only the managed keys are touched):
218
397
 
219
398
  ```ts
220
399
  export default defineConfig({
221
- tasks: ["test", "lint", "typecheck"],
400
+ tasks: ["test:unit", "lint:code", "typecheck"],
222
401
  // syncScripts: false, // disable the step
223
- // holocronScript: "node packages/cli/dist/cli.mjs", // override the "holocron" entry
402
+ // holocronScript: "node cli/cli/dist/cli.mjs", // override the "holocron" entry
224
403
  providers: { source: "github" },
225
404
  });
226
405
  ```
227
406
 
228
- Writes `"holocron": "<holocronScript ?? 'holocron'>"` plus one
229
- `"<task>": "holocron run <task>"` per runnable task. `syncScripts: false`
407
+ Writes `"holocron": "<holocronScript ?? 'holocron'>"` plus one script per runnable task, named by the task id
408
+ (`test:unit`) and one per suite (`test`, `lint`, `scan`): `turbo run <task>` in a pnpm workspace with a `turbo.json`
409
+ (or the tool's own command for a task that runs once at the root), `holocron run <task> --` in a single package.
410
+ `holocron probe generated check` fails on a root script that differs from what is generated. `syncScripts: false`
230
411
  opts out entirely.
231
412
 
232
413
  ### Splitting the task manifest — `astromech.config.ts`
@@ -240,7 +421,7 @@ The `tasks` key (plus `syncScripts` / `holocronScript` / `hooks` /
240
421
  import { defineConfig } from "@theholocron/astromech/config";
241
422
 
242
423
  export default defineConfig({
243
- tasks: [{ name: "audit", required: true, with: { "run-knip": true } }, "wiki"],
424
+ tasks: [{ name: "lint:unused", required: true }, "publish-wiki"],
244
425
  syncScripts: false,
245
426
  });
246
427
  ```
@@ -248,38 +429,56 @@ export default defineConfig({
248
429
  `@theholocron/astromech`'s `loadTasksConfig` merges it over
249
430
  `holocron.config`'s `tasks` — **task arrays concatenate**
250
431
  (`holocron.config` first), the dedicated file **wins on scalars**,
251
- `extraRequiredChecks` concatenate. `holocron run` / `holocron ci` /
252
- `holocron setup` / `holocron sync` all read the merged result, so the
432
+ `extraRequiredChecks` concatenate. `holocron run` / `holocron run ci` /
433
+ `holocron repo setup` / `holocron repo sync` all read the merged result, so the
253
434
  split is transparent. Useful for keeping the capability/provider config
254
435
  and the "what this repo runs" manifest in separate files (this repo does).
255
436
 
256
437
  ### `holocron run`
257
438
 
258
439
  ```bash
259
- holocron run <task> [job] [--required] [--filter <pkg>] [--dry-run] [-- <passthrough>]
440
+ holocron run <task | suite> [qualifier | job] [--check] [--required] [--filter <pkg>] [--dry-run] [-- <passthrough>]
260
441
  ```
261
442
 
262
- Runs one task locally — resolving turbo vs the package manager vs the tool
263
- itself. A `job` argument targets a sub-job of tasks that have them: `holocron
264
- run audit performance` runs Lighthouse CI, `holocron run audit knip` runs Knip,
265
- `holocron run audit` (no job) runs every audit sub-job in declared order. A
266
- sub-job whose tool isn't installed, or that has no local equivalent
267
- (`bundle-size`), is skipped with a note — `--required` makes that a failure. For
268
- a task with no sub-jobs the `job` slot is the first passthrough arg
269
- (`holocron run build src/`).
270
-
271
- **CI runs the identical command.** The reusable `typecheck` / `test` / `audit`
272
- workflows call the `holocron` composite action
443
+ Runs one task, or a suite, locally — resolving turbo vs the package manager vs the tool
444
+ itself. Ids are flat and verb-first: `typecheck`, `build`, `test:unit`, `lint:code`.
445
+ `holocron run test` runs the `test` suite (every `test:*` leaf the repo lists, in registry order, each reported),
446
+ `holocron run test unit` and `holocron run test:unit` run one leaf. The words are joined with `:` and the longest match
447
+ wins, so `deploy preview` is `deploy-preview`; the rest is the `job` argument. A `job` targets a sub-job of the tasks
448
+ that have them (`holocron run lint commit-msg <file>`). A leaf whose tool isn't installed, or that has no local
449
+ equivalent, is skipped with a note — `--required` makes that a failure. For a task with no sub-jobs the `job` slot is the first passthrough arg
450
+ (`holocron run build src/`). `holocron run format` writes (prettier), `holocron run format --check` is read-only.
451
+ `holocron run --help` lists the tasks grouped under the six intent groups. The old dotted names
452
+ (`verification.unitTests`, `sourceQuality.formatting`, …) still work and print a deprecation notice on stderr. <!-- holocron-allow-old-name -->
453
+
454
+ **CI runs the identical command.** The reusable workflows (`typecheck`, `test-unit`,
455
+ `lint-code`, …) call the `holocron` composite action
273
456
  (`theholocron/.github/.github/actions/holocron@main`), whose body is
274
- `holocron run <task> [job]`. So `holocron run test` locally and the `Test` CI
457
+ `holocron run <task> [job]`. So `holocron run test:unit` locally and the `test:unit` CI
275
458
  job execute the same thing — at a turbo root both are
276
- `turbo run test -- --coverage` (the registry's org-default flags flow through
277
- turbo's `--`).
459
+ `turbo run <task>`. `test:unit` always runs with coverage (`vitest run --coverage`); there is no `--coverage` flag.
278
460
 
279
- ### `holocron ci`
461
+ ### `holocron deploy on-release`
280
462
 
281
463
  ```bash
282
- holocron ci [--all] [--filter <pkg>] [--dry-run]
464
+ holocron deploy on-release [--channel <alpha|main>] [--from <commit>] [--to <commit>] [--dry-run]
465
+ ```
466
+
467
+ Deploys every workspace package whose own `holocron.config` declares
468
+ `{ name: "deploy", with: { on: "release" } }` (holocron#930), when the
469
+ release (`--channel`: its prerelease identifier, or `main`/empty for a stable
470
+ release) is on the task's `channel` (default `main`, the stable release) and changes the package or one of its
471
+ `workspace:*` dependencies between `--from` (the previous release's commit,
472
+ omitted when there is none) and `--to` (default `HEAD`). It waits for npm to
473
+ serve the release's new dependency versions, then runs `pnpm --filter <pkg>
474
+ deploy`. A package that doesn't apply is skipped; a deploy that
475
+ doesn't succeed exits non-zero. The shared `release` workflow runs it as its own
476
+ `deploy` job after the release job (opt in with `deploy-on-release: true`).
477
+
478
+ ### `holocron run ci`
479
+
480
+ ```bash
481
+ holocron run ci [--all] [--filter <pkg>] [--dry-run]
283
482
  ```
284
483
 
285
484
  Runs the merge-gating checks locally, in CI order, exiting non-zero on the
@@ -288,29 +487,53 @@ first failure — the "will my PR be green?" pre-flight, and what the
288
487
  (falling back to every `ci: true` task when nothing is marked required).
289
488
  `--all` forces the full set; `--filter` is a `turbo --filter=` passthrough.
290
489
  Order comes from the `CI_ORDER` constant in `@theholocron/astromech`
291
- (`typecheck → lint → test → build → …`). Tasks with no local equivalent
292
- (`codeql`, `deploy`) are reported as enforced-in-CI, never failures; `audit`
293
- expands into its sub-jobs (each under its own `audit / …` check context)
294
- unless the repo ships its own `"audit"` script.
295
-
296
- ### Lint parity
297
-
298
- The `lint` task takes an optional `linters` array — one list that drives
299
- **both** the CI `lint` job (super-linter's `VALIDATE_*` env, baked into the
300
- generated `.github/workflows/lint.yml` thin caller as a `super-linter-env`
301
- input) **and** `holocron run lint` locally. Omitted → auto-detected from the
302
- config files present plus the org always-on set.
490
+ (`typecheck → lint:code → … → test:unit → build → …`). Tasks with no local equivalent
491
+ (`scan:code`, `deploy`) are reported as enforced-in-CI, never failures. `format` runs in its
492
+ read-only `--check` form.
493
+
494
+ ### `holocron deploy`
495
+
496
+ `holocron deploy <branch>` (a Git-linked deployment) and `holocron deploy
497
+ --files <dir>` (a directory of build output, no linked repo) both trigger a
498
+ deployment through the configured `deployment` capability, then **wait for
499
+ it to finish**. The command reports success, exit code 0, only when the
500
+ deployment reaches `ready`. A deployment that ends `error` or `cancelled`,
501
+ or is still building after 10 minutes, is a failure: the exit code is
502
+ non-zero and the output includes the provider's own reason
503
+ (`DeploymentRecord.errorMessage`, e.g. Vercel's `Command "npm install"
504
+ exited with 1`). Providers build asynchronously, so accepting a deployment
505
+ isn't the same as it going live (holocron#911).
506
+
507
+ Provider plugins support this through the `Deployment` capability's
508
+ existing `getDeployment(id)`. They should set `errorMessage` on the
509
+ returned `DeploymentRecord` whenever the provider exposes one.
510
+
511
+ ### `holocron monitoring check <url>`
512
+
513
+ Runs every configured `monitoring` check against `<url>` instead of each
514
+ check's own configured `url` — no vendor API call, only a plain HTTP
515
+ request evaluated locally against the exact same `assertions` already in
516
+ `holocron.config.ts`. Built for CI: the `check-preview` task runs
517
+ this against a PR's Vercel preview deployment (triggered by
518
+ `deployment_status`, not `push`/`pull_request`), reusing the production
519
+ check definitions to catch a breaking change before merge instead of
520
+ after (holocron#1010).
303
521
 
304
522
  ```ts
305
523
  export default defineConfig({
306
- tasks: [{ name: "lint", linters: ["eslint", "prettier", "yamllint", "actionlint", "gitleaks"] }],
307
- providers: { source: "github" },
524
+ tasks: ["check-preview"],
525
+ providers: {
526
+ monitoring: ["checkly", { accountId: "...", checks: [/* ... */] }],
527
+ },
308
528
  });
309
529
  ```
310
530
 
531
+ Exits non-zero if any check fails — the job's own pass/fail is what
532
+ posts as the GitHub check, no separate reporting step needed.
533
+
311
534
  ### Skills installer
312
535
 
313
- `holocron setup` can install shared skills from `@theholocron/skills` into the local repo:
536
+ `holocron repo setup` can install shared skills from `@theholocron/skills` into the local repo:
314
537
 
315
538
  ```ts
316
539
  export default defineConfig({
@@ -371,18 +594,105 @@ export default acmeConfig;
371
594
 
372
595
  ```
373
596
 
597
+ ## Notifications — server as code
598
+
599
+ A `notifications` provider can declare a whole server in `holocron.config.ts`
600
+ (`layout`: categories, channels, roles, access, server settings, welcome screen,
601
+ pinned messages, onboarding, the bot application) and the CLI applies and checks it. The
602
+ commands and the config are provider-neutral; Discord is the first provider.
603
+
604
+ | Command | What it does |
605
+ | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
606
+ | `holocron notifications setup` | Applies the layout; looks everything up by name first, so a re-run changes nothing that matches |
607
+ | `holocron notifications channel add <name>` | Creates one channel (optionally with a webhook whose URL is stored as a secret) |
608
+ | `holocron notifications create-server --name <n> --owner <id>` | Creates the server the layout describes, writes its id into the config, applies the layout, invites the owner, waits for them to join and hands the server over (`--resume` finishes an interrupted hand-over; `--force` allows a second server) |
609
+ | `holocron notifications link` | Links your account on the provider to your GitHub account by signing in with the provider (OAuth, nothing secret kept) |
610
+ | `holocron notifications sync-roles` | Makes who holds a role match a GitHub team, through the links file (`--keep` only adds; `--provider` picks one) |
611
+ | `holocron project reconcile [board]` | Sets item statuses where a rule says so: an open blocker means `blocked`, no blocker left means `planned`, closed means `done` (status only; `--dry-run` previews; an open item with no status is reported). Runs hourly from `platform.projectReconcile.yml`, which `repo setup` writes when `providers.projects` declares boards |
612
+ | `holocron doctor notifications [--built-only] [--deliver] [--post]` | Step by step: does the server match the layout, do the secrets exist, and does a person (not the bot) own it. A full run also leaves one `🧪 test:` post in the layout's `testChannel`; `--built-only` posts nothing; `--deliver` posts to every channel and removes each post; `--post [channel]` posts the result as the bot (the failures, or only the summary when none failed). It also reads the Checkly feed (webhook, alert channel, subscriptions), the Comlink relay (Worker, route, bindings, the tracker's integration and rule) and the Notifications workflow (the file, and the secrets it reads), posting nothing, so `--built-only` keeps those steps |
613
+ | `holocron doctor variables` | Do the Actions variables `repo.variables` declares exist, with those values (and, for the organization's, that visibility)? One row for the repository and one for the organization, each only when declared. Read-only. An undeclared variable counts only with `prune`; a scope that cannot be read (no provider, no org token) is a skip, not a failure |
614
+ | `holocron doctor ci` | Has the repo moved to the flat task vocabulary? One row each for the `tasks:` entries (a deprecated alias, with the id that replaces it), the generated callers (file, workflow and job name equal the task id), the `ci` aggregate's `expected` list (no id missing or stale) and where the callers point (`theholocron/.github` or holocron `ci-v1`). Read-only, no provider needed; exits 1 on a failure. The ruleset's checks are `doctor repo`'s |
615
+ | `holocron doctor environments` | Do the deployment environments exist? The ones `repo setup` creates (`staging`, `production`, when an `environments` provider is configured) plus every environment `repo.secrets.environments` names. One row. A missing one fails; an extra one is never a problem; no provider with some named is a skip |
616
+ | `holocron doctor project [--post [channel]]` | Does each board `providers.projects.boards` declares exist and match its template? One row per board, status list, field, view and automation rule; the board's extras and the items `project reconcile` would fix (no status, closed but not done, open blocker but not blocked, blocked without a blocker) are `info` rows, never a failure. A template file that does not read fails, naming the file. Read-only; `--post` shares the failing rows through the `notifications` bot. |
617
+ | `holocron doctor credentials` | Does the credentials environment exist, and does it hold every variable the configured plugins take? One row per variable and provider (`ok`, `fail` when missing, `skip` for an optional one not set), listing names only: it never reads a value, and says which spelling of the environment's name matched. |
618
+ | `holocron doctor repo` | Do the repository settings `repo setup` writes match the config? One row per group the config declares: description and homepage, default branch and merge settings, topics, custom properties, team access, branch protection; labels and security settings are always checked. Read-only. Reads through optional `Source` methods (`getRepoInfo`, `getProperties`, `listLabels`, `listTeamAccess`, `getRulesetDetail`, `getSecurity`); a group that cannot be read is a skip, not a failure |
619
+ | `holocron doctor dns` | Do the DNS records the config makes setup write exist, pointing where they should? The preview domain's apex and wildcard CNAMEs (Cloudflare), the docs host a wiki provider asks for, and the relay Worker's proxied placeholder; one row per zone. A missing record, another target or a missing proxy fails; an extra record never does. A record `ensureCustomDomain()` returns is not checked, because asking for it creates the domain |
620
+ | `holocron doctor monitoring` | Do the checks the `monitoring` provider declares exist in its account, matched by name, with the URL, method and (when stated) frequency, locations, activated, should-fail, body and assertions the config sets? One row. A check in the account that is not declared is never a problem. A provider that cannot list its checks, failed to load or has no token is a skip |
621
+ | `holocron doctor secrets` | Do the secrets the config says must exist (`repo.secrets`, plus the notification layout's webhook and role secrets and the Chromatic token) exist? One row for the repository, the organization and each environment, each only when something is expected there. Names only; an undeclared secret is never a problem. A scope that cannot be read is a skip |
622
+ | `holocron doctor tokens` | For every token a configured plugin lists (every plugin that resolves one: GitHub's nine, Discord's three, Sentry's two, ...), looked up as the plugin does (its env var, the vendor's, then keyring) and verified with its `verifyToken`: set and accepted is ok (with how long is left, when the token expires), set and rejected fails, a token with 7 days or fewer left fails with `expires in N days: renew it`, not set is a skip. No token is printed. What a token may do is not checked, because GitHub does not return a fine-grained token's permissions |
623
+ | `holocron doctor --all` | Runs every deep check (`doctor notifications`, `doctor variables`, ...) and prints one row each, then `N ok, N fail, N skipped` counted in checks. Exits 1 when any check failed. A check that cannot run (no provider, no token) is a skip with the reason. Read-only: notifications runs as `--built-only`, so it posts nothing |
624
+ | `holocron probe [<provider> [<probe>]] [--dry-run] [--yes] [--lcov <path>]` | Poke a live provider on purpose: list the probes, inspect something, or run a proof that cleans up after itself. Plugins offer the probes; nothing secret is printed; one that changes things asks first |
625
+
626
+ Channels fed by another service are declared with `feeds` on the channel: `{ name: "uptime", webhook: true, feeds: { monitoring: true } }` (the object form `{ name?, webhook?, avatar?, alerts? }` overrides the alert channel's name, default `Message to #<channel>`, the dedicated webhook's name, default the provider's, and gives that webhook a picture, a file path or `https://` URL, or `{ url, image }` (the URL is tried first, the file in the repo is the fallback), else the provider's own icon (`Monitoring.icon`, a URL and an embedded `data:` image; Checkly provides one), else the layout's `webhookAvatar`). A channel's own `webhook.avatar` and the layout's `webhookAvatar` take the same forms, a path or `https://` URL, or `{ url, image }` (the URL first, the file in the repo as the fallback); a relative path is read from the repository root. `setup` gives the channel a dedicated webhook and hands its URL straight to the `monitoring` provider through `Monitoring.ensureAlertChannel({ name, format: "discord", url? })`, which finds an alert channel of that name or creates one and subscribes every check; the URL is never stored as a secret. It needs a `monitoring` provider that implements `ensureAlertChannel` (Checkly does). `alerts: { failure?, recovery?, degraded?, sslExpiry?, sslExpiryThreshold? }` (`MonitoringAlertSettings`, passed as `ensureAlertChannel({ ..., alerts })`) sets what the alert channel alerts about: a new channel defaults to failure, recovery and degraded on and `sslExpiry` off, and on an existing channel a setting left out is left alone. A check in the `monitoring` provider's `checks` can route itself with `alertChannels: ["Message to #uptime"]` (`MonitoringCheckInput.alertChannels`, the alert channel names): it is then subscribed to those channels only, and a name no feed declares is refused by `setup`. `inspectAlertChannel` returns the channel's `alerts` and the `misrouted` checks that `doctor notifications` reports. Two feeds may not share an alert channel name, and a feed's webhook may not share the channel's own webhook name (compared without regard to case).
627
+
628
+ Channels fed by the error tracker add `feeds: { errors: true }` and a layout `relay: { host, zone?, script?, code? }`: `setup` makes a dedicated webhook, points `host` at the Comlink Worker (a proxied DNS record via `dns`), and deploys it via `workers.deployScript` with the webhook URL as `COMLINK_<SOURCE>_WEBHOOK`. The URL never leaves the Worker's secret; other secrets on the script are kept. With `relay.errors: { projects, integration?, rule?, frequency? }` it also ensures the tracker's integration and alert rule (`errors.ensureRelay`) and deploys the Worker with the integration's signing secret. Needs `errors`, `workers` and `dns`; only one channel may be fed.
629
+
630
+ `holocron secrets sync <env> --worker <script>` also sets every key of the vault environment on a deployed Worker as a secret, through the optional `Workers.setSecret(script, name, value)` (write-only; the Cloudflare plugin implements it). The Worker must already exist. Sync only adds and updates: it never removes a binding, because a Worker also holds secrets that are not in the vault (for Comlink, the `COMLINK_<SOURCE>_WEBHOOK` that `notifications setup` sets), so a key deleted from the vault must be deleted from the Worker separately. Keys are written one at a time and each is reported; if one fails, the exit code is 1 and re-running finishes the rest, since every write is idempotent.
631
+
632
+ `holocron secrets list [--scope repo|environment|organization] [--env <name>] [--json]` prints the names (never the values; GitHub does not return them) of the secrets at each scope, sorted, under a heading per scope. With no `--scope` it lists the repository, plus the organization (`--org`, `HOLOCRON_ORG` or the config's `org`) and the `--env` environment when they are known; `--scope` lists one. A scope that cannot be listed is reported under its heading and the rest are still listed; the exit code is 1 if any failed. `--json` prints `[{ scope, names, error? }]`. It is read-only, so `--dry-run` does not apply. Comparing the names with what the config expects is `doctor secrets`, which also covers the keys of the vault environments declared in `repo.secrets.sync`.
633
+
634
+ A channel with `kind: "forum"` is a forum, with `tags` (each a `name`, an `emoji` and whether it is `moderated`); `setup` adds and corrects the tags but never removes one, and a text channel of the same name must be deleted first, since neither kind can become the other. A forum takes no `webhook` or `feeds`.
635
+
636
+ `holocron specs sync [--channel <forum>] [--files <paths...>] [--pr <number>] [--refresh] [--refresh-origin] [--refresh-titles] [--withdraw] [--notify]` keeps one forum post per ADR and spec in step with the files: it makes the post (titled with the document's own title, tagged with the file's status), writes its address into the file as `discussion.url`, and turns a gatekeeper's retag into an edit of the file's `status:` line in the working tree for a pull request. `--files` syncs only those files and `--pr` names a pull request on their posts, for a pull request that is still open. `--refresh-origin` is a one-off repair: it rewrites the `PR:` line of existing posts to the one the current rule names (the optional `prLine` of `DiscussionPatch`, and of `DiscussionPost`), and nothing else in them. `--refresh-titles` is the same kind of one-off repair for the title: it renames each existing post whose title differs from the current rule's (the optional `title` of `DiscussionPatch`, and of `DiscussionPost`) and changes nothing else; a rate limit stops it cleanly, reports how many documents are left, and the next run continues. The id that opens a post is a link to the file on the default branch (`repo.defaultBranch`, else `HEAD`) once the file is there, and plain text while `--pr` names an open pull request; the normal sync rewrites a post's id line (and only that line) whenever it is not the one the rule gives and no `--pr` is given, which covers a file that moved and a post made while its pull request was open, so it needs no extra request when every post is right and `--refresh` is no longer needed for it. `--refresh` runs the `PR:`, title and id-link repairs in one pass (the id link is the optional `idLine` of `DiscussionPatch`, and of `DiscussionPost`, which changes only the message's first line); `--refresh-origin` and `--refresh-titles` still do only their own. `--withdraw` (with `--files`, on the base branch) tags the posts of a pull request closed unmerged `withdrawn` and closes them; `withdrawn` is a tag only, never a file `status:`, and the next sync puts the file's own status back. It cannot be combined with `--refresh`, `--refresh-origin` or `--refresh-titles`. `--dry-run` previews it. See the [`specs sync` page](https://docs.theholocron.dev/holocron/commands/specs-sync/).
637
+
638
+ Pinned messages are declared under the provider's `layout` as `pinned: [{ channel, content }]` or `pinned: [{ channel, file }]` (`channel` is a channel in the layout, `content` up to 2000 characters, `file` a text file in the repository, such as `.holocron/pinned/rules.md`, whose contents are the message and win over a hand edit; `doctor notifications` reports the drift); the layout is the whole set of messages the bot has pinned in those channels.
639
+
640
+ Config shape added for role sync and sign-in (all under the provider's `layout`):
641
+
642
+ | Field | Meaning |
643
+ | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
644
+ | `testChannel` | The channel (it must declare a webhook) the doctor posts its one self-removing test message to. |
645
+ | `roles[].team` | A GitHub team slug. The role follows that team: given to linked members, taken from linked people who left. Never touches holders nobody has linked. |
646
+ | `links.hostedUrl` | A hosted sign-in service (Sentinel). `link` asks `<hostedUrl>/api/link` and uses it when it answers `{ "service": "link" }`; otherwise it signs in locally. |
647
+ | `links.localPort` | The port of the local sign-in listener (default `53682`, bound to `127.0.0.1` only). |
648
+ | `links.repo` / `links.path` | Where the links file lives (default `<org>/.github-private` and `notifications/<provider>-links.json`). |
649
+ | `application.intents.members` | Switches the Server Members Intent on or off (needed to list who holds a role). |
650
+ | `application.redirectUris` | Redirect URIs that must be registered. Check-only: the API cannot set them, so `setup` and the doctor say what to add in the developer portal. |
651
+
652
+ The links file is `{ "version": 1, "links": [{ "github": "<id>", "login": "<login>", "member": "<id>" }] }`: two public ids per person.
653
+ It is read and written through the `source` capability with the `github.user-sync` token (fine-grained, **only** the
654
+ private config repo, Contents read and write), so no other token needs Contents on other repositories.
655
+
656
+ Capability surface behind it (all optional, so providers without the concept omit them):
657
+
658
+ - `Source.teamMembers(teamSlug, org?)`, `Source.readFile(path, repo?)` (returns the `version` a later write must present),
659
+ `Source.writeFile(path, content, { message, version?, repo? })` (a changed `version` is refused: a real conflict check).
660
+ - `Notifications.createServer({ name, force? })`, `inviteLink(channel)`, `hasMember(id)`, `transferServer(id)` and `serverOwner()`: create a server, invite its owner, check they joined, hand it over, and say who owns it.
661
+ - `Notifications.roleMembers(role)`, `addRoleMember(role, memberId)`, `removeRoleMember(role, memberId)`.
662
+ - `Notifications.checkDelivery({ channel, name, category?, text })`: posts through a channel's webhook, reads the post back and removes it, and says which step failed.
663
+ - `Notifications.signIn()` returning `{ authorizeUrl, complete }`: the provider-neutral shape of "prove which account you own".
664
+ - `Notifications.ensureApplication` returns `{ updated, todo? }`; each `todo` is a step only a person can do (a portal setting
665
+ the API ignores) and is reported as a failure until done.
666
+
667
+ Provider credentials for Discord: `discord.holonet` is the **bot token** (Bot → Reset Token), `discord.holonet.oauth` is the
668
+ **OAuth client secret** (OAuth2 → Reset Secret). They are different values; the API can create or read neither.
669
+
670
+ See the [command pages](https://theholocron.dev/holocron/commands/notifications-setup/) for each command's options.
671
+
672
+ ## Cleaning up
673
+
674
+ - **`holocron repo cleanup branches [--local | --remote]`** — lists the branches whose pull request is merged,
675
+ grouped, each saying whether it lives locally, on the remote or both; then asks, and offers a checklist with the
676
+ proven-merged ones ticked. Proven merged means an ancestor of `origin/alpha` or `origin/main`, or the head (or an
677
+ ancestor, or one of the commits) of a merged pull request. Branches with more commits than their merged PR, with
678
+ an open PR, checked out (here or in a worktree), or never merged are listed unticked. `--dry-run` only lists;
679
+ `--yes` deletes every proven-merged branch without asking. Pull requests and remote branches come from the
680
+ `source` provider (`Source.listPullRequests`, `listPullRequestCommits`, `listBranches`, `deleteBranch`).
681
+
374
682
  ## Upgrading
375
683
 
376
- - **`holocron upgrade node <to>`** — patches every Node.js version pin
684
+ - **`holocron repo upgrade node <to>`** — patches every Node.js version pin
377
685
  (`engines.node`, `.nvmrc`, `.node-version`, `.github/workflows/*`,
378
- `Dockerfile`, `.tool-versions`) to a new major.
379
- - **`holocron upgrade deps`** — bumps every `@theholocron/*` pin in
686
+ `Dockerfile`, `.tool-versions`) to a new major. The rewrite is
687
+ `runUpgradeNode()` in `@theholocron/astromech/upgrade`; the command only
688
+ binds the logger and reads `upgrade.node.extra`.
689
+ - **`holocron repo upgrade deps`** — bumps every `@theholocron/*` pin in
380
690
  `pnpm-workspace.yaml` (`catalog:` and every named `catalogs.*`) to its latest
381
691
  published version, then migrates `holocron.config.ts` from the 7.x preset
382
692
  shape (`const { repo, workflows } = node()` + `repo.requiredChecks` +
383
693
  `workflows:`) to the current composed-preset API (`const preset = node()` +
384
694
  `...preset` + `tasks:` + `extraRequiredChecks:`). Mechanical transforms only —
385
- review the result, then `pnpm install && holocron ci`. `--pins-only` skips
695
+ review the result, then `pnpm install && holocron run ci`. `--pins-only` skips
386
696
  the config migration; `--dry-run` prints without writing.
387
697
 
388
698
  ## Auth — fine-grained tokens
@@ -397,37 +707,59 @@ holocron auth set github.issues ghp_xxx # issue management
397
707
  holocron auth set github.sync ghp_xxx # sync-github workflow templates
398
708
  holocron auth set github.release ghp_xxx # semantic-release
399
709
  holocron auth set github.admin ghp_xxx # setup, secrets, environments
710
+ holocron auth set github.user-sync ghp_xxx # the files that link GitHub accounts to other services' members
400
711
  ```
401
712
 
402
713
  The resolution chain per capability is:
403
714
 
404
- ```
715
+ ```text
405
716
  --token flag → HOLOCRON_<FEATURE>_TOKEN env var → keyring("github.<feature>")
406
717
  ```
407
718
 
408
719
  See [`docs/tokens.md`](../../docs/tokens.md) for required PAT scopes per feature.
409
720
 
721
+ A plugin lists the tokens it takes in a `tokens: PluginToken[]` export (each resolver exposes its own as `.token`), as
722
+ `{ envName, vendorEnvName?, keyringKey, verifiable?, optional? }`, so `holocron doctor tokens`, `doctor credentials` and
723
+ `auth export` can find them. Set `optional: true` on a token the plugin only falls back to, such as the Discord
724
+ webhook a post uses when it names no channel: the checks that expect every listed token do not expect it, and
725
+ `auth export` marks it `(optional)` when it has no value. `verifiable: false` marks a token `verifyToken` does not
726
+ apply to.
727
+
410
728
  Additional `auth` subcommands:
411
729
 
412
730
  ```sh
413
731
  holocron auth check github.read # re-verify a stored token
414
732
  holocron auth unset github.read # remove a stored token
415
733
  holocron auth list # show all stored providers
734
+ holocron auth export # tokens as NAME=value lines in a private .credentials, to import into a credentials environment
735
+ holocron auth export --only HOLOCRON_SENTRY_TOKEN # one token, to the clipboard
736
+ holocron auth export --blank --vendor-names --file --only VERCEL_TOKEN --only HOLOCRON_RELEASE_TOKEN # the stored ones filled, the rest empty
737
+ holocron github-app create --name "My App - dev" --webhook-url https://<tunnel>/api/webhook --manifest apps/sentinel/github-app.manifest.json # a GitHub App from a manifest (the flow is in @theholocron/dagobah); its id, key and webhook secret to a private .credentials
738
+ holocron tunnel up --name sentinel-dev --hostname sentinel-dev.example.dev --port 3000 --run # a named tunnel with a stable hostname to a local port
739
+ holocron project list # the org's project boards (also: create [template], close <number-or-name>, setup)
740
+ holocron project move v4 v5 --dry-run # preview carrying the open items of one project board to another; without --dry-run it asks first (--yes skips)
741
+ holocron doctor project # does each declared board match its template? (read-only; --post shares the failures)
742
+ holocron dev # the app, its vault variables and the tunnel, in one command (settings: `dev` in holocron.config)
416
743
  ```
417
744
 
418
745
  ## Logging
419
746
 
420
747
  Operational output goes through `@theholocron/observability/logger` — separate
421
- from the user-facing `print` surface. Global flags:
748
+ from the user-facing `print` surface. Local/interactive runs are quiet by
749
+ default: no colorized or raw structured console output, regardless of the
750
+ resolved level (Axiom shipping, when configured, is unaffected). CI is
751
+ untouched — its existing stdout output still appears. Global flags:
422
752
 
423
753
  ```sh
424
- holocron doctor --verbose # log level → debug (full structured output)
425
- holocron doctor --quiet # log level → error (suppress info + warn)
754
+ holocron doctor --log debug # show console output at this level (opt back in)
755
+ holocron doctor --verbose # log level → debug, and shows console output
756
+ holocron doctor --quiet # log level → error, and shows console output
426
757
  holocron doctor --debug # print "Run ID: <uuid>" at command end for Axiom lookup
427
758
  ```
428
759
 
429
- Level resolution (highest priority first): `--verbose` / `--quiet` →
430
- `HOLOCRON_LOG_LEVEL` → `log.level` in `holocron.config` → `"info"`.
760
+ Level resolution (highest priority first): `--log <level>` → `--verbose` /
761
+ `--quiet` → `HOLOCRON_LOG_LEVEL` → `log.level` in `holocron.config` →
762
+ `"info"`.
431
763
 
432
764
  ```ts
433
765
  export default defineConfig({
@@ -439,7 +771,16 @@ Axiom shipping activates when a token (`HOLOCRON_AXIOM_TOKEN` / `AXIOM_TOKEN`
439
771
  → OS keyring `axiom.<org>` → `axiom`) **and** a dataset
440
772
  (`HOLOCRON_AXIOM_DATASET` / `AXIOM_DATASET` → `log.axiom.dataset` in
441
773
  `holocron.config`) both resolve; env vars win. The token is never read from a
442
- config file. See the [logging guide](https://docs.theholocron.dev/holocron/logging/).
774
+ config file.
775
+
776
+ The dataset side of that resolution is **execution-context-aware** (ADR-0012):
777
+ a `global`-context command (`clone`, `new`, `auth set`, `upgrade node`, `plugin
778
+ create`, …) always ships to holocron's own dataset regardless of `$PWD` — it
779
+ isn't "about" any repo, so routing it through whichever repo's `.envrc`
780
+ happens to be active would be wrong. `repo-aware` / `workspace` commands
781
+ (`doctor`, `deploy`, `sync`, …) keep the env-var/config chain above, so a
782
+ per-repo `HOLOCRON_AXIOM_DATASET` — e.g. via a `.envrc` + `direnv` — separates
783
+ each consuming repo's logs. See the [logging guide](https://docs.theholocron.dev/holocron/logging/).
443
784
 
444
785
  ### Telemetry
445
786
 
@@ -468,38 +809,80 @@ export default defineConfig({
468
809
 
469
810
  Each SDK sits behind an interface from `@theholocron/observability` —
470
811
  `ErrorSink` (Sentry) / `AnalyticsSink` (PostHog); the adapters, and the only
471
- `@sentry/node` / `posthog-node` imports, live in that package. `telemetry.ts`
472
- holds the orchestration + the Holocron-specific credential resolution
473
- (`telemetry/resolve.ts`). See the
812
+ `@sentry/node` / `posthog-node` imports, live in that package. the orchestration is `createCliTelemetry` in `@theholocron/kyber/observability`;
813
+ `observability/telemetry.ts` binds it to the Holocron-specific credential resolution
814
+ (`observability/resolve-telemetry.ts`). See the
474
815
  [telemetry guide](https://docs.theholocron.dev/holocron/telemetry/).
475
816
 
817
+ ### ESLint bundle options
818
+
819
+ Most repos need nothing here — `@theholocron/eslint-config`'s `library()`
820
+ bundle resolves with zero committed file (Bucket A: `eslint --config
821
+ <shared path>`, no per-repo `eslint.config.ts` needed). A package with a
822
+ genuine, deliberate exception — e.g. Web Crypto globals a Node-targeted
823
+ package still needs, exempted via `library()`'s own `browserPackages`
824
+ option in that package's own `eslint.config.ts` — should also declare the
825
+ same paths in `holocron.config`'s `eslint.browserPackages`:
826
+
827
+ ```ts
828
+ export default defineConfig({
829
+ eslint: {
830
+ browserPackages: ["clients/github-client/src/app-auth"],
831
+ },
832
+ });
833
+ ```
834
+
835
+ This doesn't replace the package's own `eslint.config.ts` (local/CI linting
836
+ still resolves that file directly) — it's the signal Sentinel's centralized
837
+ static-analysis check (holocron#849/#858) reads instead, since that check
838
+ never reads a PR's own committed config files. Without it, Sentinel flags a
839
+ false-positive `eslint-plugin-n` node-builtins finding on exactly the files
840
+ the local override exists to exempt.
841
+
476
842
  ## What's in here
477
843
 
478
- - `src/capabilities/` — the 14 capability interfaces that providers
479
- implement
844
+ - `src/plugin/capabilities.ts` — the 21 capability interfaces that
845
+ providers implement
480
846
  - `src/config.ts` — config schema, `defineConfig`, `resolveConfig`,
481
847
  `CapabilityConfigPackage`
482
- - `src/config/load-config.ts` — `loadConfig` — reads `holocron.config.*`
483
- (file discovery via [`@theholocron/datapad`](../datapad))
484
- - `src/define-config.ts` — `defineConfig` typed pass-through
485
- - `src/logger.ts` — CLI-side `@theholocron/observability/logger` wiring
848
+ - `src/config/config-system.ts` — `defineConfig`, `loadConfig` (reads `holocron.config.*`;
849
+ file discovery via [`@theholocron/datapad`](../datapad)) and `compose`, all built from
850
+ kyber's `createConfigSystem`; Holocron's own rules sit beside it in `config/config`,
851
+ `compose/{merge-*,task-name}` and `load-config/{derive-defaults,read-package-json-name}`
852
+ - `src/observability/logger.ts` — CLI-side `@theholocron/observability/logger` wiring
486
853
  (`buildCliLogger`, `resolveLogLevel`)
487
- - `src/loader.ts` — `PluginLoader` — dynamic-imports plugins, resolves
488
- capability config packages, builds the capability registry
854
+ - `src/plugin/loader/loader.ts` — `PluginLoader`, a binding of kyber's `createPluginSystem`
855
+ (`@theholocron/kyber/plugins`: dynamic-imports plugins, resolves capability config packages,
856
+ builds the capability registry); Holocron's prefix, plugin options and the credentials / `.env`
857
+ step are passed in
489
858
  - `src/cli.ts` — yargs entry, dispatches subcommands. `holocron run` / `ci` are
490
859
  delegated to [`@theholocron/astromech`](../astromech) (`createAstromech`).
491
- `holocron sync` / `holocron setup` write each repo's `.github/workflows/*.yml`
492
- thin callers from `astromech.thinCallers()`; `holocron sync-github` pushes the
860
+ `holocron repo sync` / `holocron repo setup` write each repo's `.github/workflows/*.yml`
861
+ thin callers from `astromech.thinCallers()`; `holocron sync github` pushes the
493
862
  reusable `workflow_call` implementations + composite actions from
494
- `astromech.reusableTemplates()` to `theholocron/.github` (a pure sync target —
863
+ `astromech.reusableTemplates()` (written in `ci/`) to `theholocron/.github` (a pure sync target —
495
864
  never hand-edit its `.github/workflows/*`).
496
- - `src/commands/` — `setup`, `sync`, `doctor`, `deploy`, `secret set`,
497
- `secrets sync`, `publish`, `bump-versions`, `sync-github`, `upgrade node`,
498
- `upgrade deps`, `plugin create`, `auth`
499
- - `src/interactive-menu.ts` — the interactive fallback: `COMMAND_REGISTRY`,
500
- `launchMenu` (Layers 1–2, picks + spawns a fresh `holocron <command>`),
501
- `promptForPositionals` (Layer 3, called inline from each leaf command's
502
- `cli.ts` handler)
865
+ - `src/commands/` — `repo setup`, `repo sync`, `doctor`, `deploy`,
866
+ `monitoring check`, `secrets list`, `secrets set`, `secrets sync`, `package publish`,
867
+ `package bump-versions`, `package move-tag`, `sync github`, `repo upgrade node`,
868
+ `repo upgrade deps`, `new plugin`, `auth`, `notifications setup`,
869
+ `notifications channel add`, `notifications link`,
870
+ `notifications sync-roles`, `doctor ci`, `doctor credentials`, `doctor dns`, `doctor environments`, `doctor monitoring`, `doctor notifications`, `doctor project`, `doctor repo`, `doctor secrets`, `doctor tokens`, `doctor variables`
871
+ `notifications sync-roles`, `project reconcile`, `doctor ci`, `doctor credentials`, `doctor dns`, `doctor environments`, `doctor monitoring`, `doctor notifications`, `doctor repo`, `doctor secrets`, `doctor tokens`, `doctor variables`
872
+ - `src/commands/deep-checks/` — `DEEP_CHECKS`, the registry every `doctor <capability>` is
873
+ listed in; the shared row renderer and `declaredVsActual` helper are in `@theholocron/kyber/ui`
874
+ - `src/interactive-menu/` — the interactive fallback's Holocron data: `command-catalog`
875
+ (`COMMAND_REGISTRY`, built with kyber's `createCommandRegistry`; each entry's `positionals`/`options`), `run-menu-entries`
876
+ and `probe-menu-entries` (menu entries built at run time), and `menu.ts`,
877
+ kyber's `createMenu` bound to the `holocron` bin and `HOLOCRON_` env prefix.
878
+ The engine itself (the picker, argv and secret env, the dry-run preview, the spawn)
879
+ and the prompting pieces — `promptForPositionals`, `promptForOptions` — live in
880
+ `@theholocron/kyber` (`/menu`, `/prompts`), which has no knowledge of commands.
881
+ - `src/plugin/connection-probe/` — the `connectionProbe` a plugin offers, kyber's `connectionProbe` (`@theholocron/kyber/checks`)
882
+ typed as the plugin system's `Probe` with `verify` returning `VerifyTokenResult`; `monitoring check` runs its checks
883
+ with kyber's `runCheckAgainstUrl`.
884
+ - `src/commands/move-tag/` — the `package move-tag` yargs command, the registry entry and `runMoveTag`, which adds the
885
+ command-bound logger to kyber's `moveMajorTag` (`@theholocron/kyber/git`).
503
886
 
504
887
  ## Status
505
888