@theholocron/cli 5.0.0-alpha.27 → 5.0.0-alpha.271

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
+ ```
23
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:
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
 
@@ -103,18 +186,20 @@ A minimal config — for repos with a `package.json` and a GitHub remote
103
186
 
104
187
  ### repo options
105
188
 
106
- Additional `repo` fields recognised by `holocron setup`:
189
+ Additional `repo` fields recognised by `holocron repo setup`:
107
190
 
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. |
191
+ | Field | Type | Description |
192
+ | ----------------- | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
193
+ | `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`. |
194
+ | `repo.topics` | `string[]` | GitHub topics set on the repository. |
195
+ | `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. |
196
+ | `repo.properties` | `RepoProperties` | Org-level custom property values synced to the GitHub dashboard. |
197
+ | `repo.variables` | `{ repo?, org?, prune? }` | GitHub Actions variables created and updated by `holocron repo setup`. Undeclared ones are left alone unless `prune` is on. |
198
+ | `repo.secrets` | `{ repo?, org?, environments? }` | 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. |
114
199
 
115
200
  ### Custom properties synced to GitHub
116
201
 
117
- `holocron setup` and `holocron sync` both call `syncProperties()` with two
202
+ `holocron repo setup` and `holocron repo sync` both call `syncProperties()` with two
118
203
  kinds of fields — always one-way (`holocron.config.ts` → resolved →
119
204
  properties; properties are never a second editable source of truth):
120
205
 
@@ -139,7 +224,7 @@ properties; properties are never a second editable source of truth):
139
224
  | `holocron_compliance` | `"compliant" \| "non-compliant"` against a minimal `source` + `ci` baseline |
140
225
 
141
226
  Field definitions and derivation heuristics:
142
- `.notes/tech-holocron-platform.spec.md` → "Custom-properties sync — field
227
+ `docs/wiki/specifications/tech-holocron-platform.spec.md` → "Custom-properties sync — field
143
228
  definitions (#677)".
144
229
 
145
230
  The four derived fields' pure computation —
@@ -160,7 +245,7 @@ posts, instead of reporting pass/fail.
160
245
 
161
246
  ### Required status checks (`protection: "strict"`)
162
247
 
163
- `holocron setup` builds the branch-protection required-check list from the
248
+ `holocron repo setup` builds the branch-protection required-check list from the
164
249
  manifest, not a hand-maintained array:
165
250
 
166
251
  - `"DCO"` (hard-prepended), then
@@ -186,12 +271,32 @@ The generated ruleset also sets `require_extra_approval_for_unattributed_changes
186
271
  false` — with `required_approving_review_count: 0` and a single maintainer, the
187
272
  GitHub default (`true`) is an unsatisfiable block on any PR with an
188
273
  unverified/unattributed commit. Repository-admin bypass still covers the real
189
- risk. And the `codecov.yml` `holocron setup` writes carries `if_not_found:
274
+ risk. And the `codecov.yml` `holocron repo setup` writes carries `if_not_found:
190
275
  success` on every status default, so an infra-only PR (dep bump, config,
191
276
  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
277
+ required check that never posts. A re-run of `holocron repo setup` backfills both into
193
278
  an existing repo.
194
279
 
280
+ ### Default branch (`repo.defaultBranch`)
281
+
282
+ ```ts
283
+ export default defineConfig({
284
+ repo: { protection: "strict", defaultBranch: "alpha" },
285
+ providers: { source: "github" },
286
+ });
287
+ ```
288
+
289
+ `holocron repo setup` syncs GitHub's repo-level default branch (`HEAD`) — what a
290
+ fresh clone checks out, what `gh pr create`/the compare UI target by default,
291
+ and what Sentinel's `validateConfig()` reads (it only ever reads config from
292
+ the repo's default branch, never a PR ref — a deliberate security boundary).
293
+ Omit this field to leave GitHub's current setting untouched; most repos never
294
+ need it. It exists for a repo using a `main`/`alpha` prerelease-channel split
295
+ where active development happens on a non-`main` branch: set this to that
296
+ branch so Sentinel validates against what's actually being developed, then
297
+ change it back once that branch merges to `main` for a stable cut and stops
298
+ being the active branch.
299
+
195
300
  ### Git hooks
196
301
 
197
302
  ```ts
@@ -202,7 +307,7 @@ export default defineConfig({
202
307
  });
203
308
  ```
204
309
 
205
- `holocron setup` writes `.husky/pre-push` (runs `holocron ci` before every
310
+ `holocron repo setup` writes `.husky/pre-push` (runs `holocron run ci` before every
206
311
  push) and `.husky/pre-commit` (runs `gitleaks protect --staged` + `lint-staged`
207
312
  before every commit — scoped to staged changes, not the whole history, so a
208
313
  past false positive can't permanently block future commits) and sets
@@ -213,14 +318,14 @@ setup --hooks` / `--no-hooks` override per run. Bypass one push with `git push
213
318
 
214
319
  ### Task scripts
215
320
 
216
- `holocron sync` reconciles `package.json#scripts` from the `tasks` manifest
321
+ `holocron repo sync` reconciles `package.json#scripts` from the `tasks` manifest
217
322
  (merge, never clobber — only the managed keys are touched):
218
323
 
219
324
  ```ts
220
325
  export default defineConfig({
221
326
  tasks: ["test", "lint", "typecheck"],
222
327
  // syncScripts: false, // disable the step
223
- // holocronScript: "node packages/cli/dist/cli.mjs", // override the "holocron" entry
328
+ // holocronScript: "node cli/cli/dist/cli.mjs", // override the "holocron" entry
224
329
  providers: { source: "github" },
225
330
  });
226
331
  ```
@@ -248,8 +353,8 @@ export default defineConfig({
248
353
  `@theholocron/astromech`'s `loadTasksConfig` merges it over
249
354
  `holocron.config`'s `tasks` — **task arrays concatenate**
250
355
  (`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
356
+ `extraRequiredChecks` concatenate. `holocron run` / `holocron run ci` /
357
+ `holocron repo setup` / `holocron repo sync` all read the merged result, so the
253
358
  split is transparent. Useful for keeping the capability/provider config
254
359
  and the "what this repo runs" manifest in separate files (this repo does).
255
360
 
@@ -276,10 +381,27 @@ job execute the same thing — at a turbo root both are
276
381
  `turbo run test -- --coverage` (the registry's org-default flags flow through
277
382
  turbo's `--`).
278
383
 
279
- ### `holocron ci`
384
+ ### `holocron deploy on-release`
385
+
386
+ ```bash
387
+ holocron deploy on-release [--channel <alpha|main>] [--from <commit>] [--to <commit>] [--dry-run]
388
+ ```
389
+
390
+ Deploys every workspace package whose own `holocron.config` declares
391
+ `{ name: "delivery.deploy", with: { on: "release" } }` (holocron#930), when the
392
+ release (`--channel`: its prerelease identifier, or `main`/empty for a stable
393
+ release) is on the task's `channel` (default `main`, the stable release) and changes the package or one of its
394
+ `workspace:*` dependencies between `--from` (the previous release's commit,
395
+ omitted when there is none) and `--to` (default `HEAD`). It waits for npm to
396
+ serve the release's new dependency versions, then runs `pnpm --filter <pkg>
397
+ delivery.deploy`. A package that doesn't apply is skipped; a deploy that
398
+ doesn't succeed exits non-zero. The shared `delivery.publish` workflow runs it as its own
399
+ `deploy` job after the release job (opt in with `deploy-on-release: true`).
400
+
401
+ ### `holocron run ci`
280
402
 
281
403
  ```bash
282
- holocron ci [--all] [--filter <pkg>] [--dry-run]
404
+ holocron run ci [--all] [--filter <pkg>] [--dry-run]
283
405
  ```
284
406
 
285
407
  Runs the merge-gating checks locally, in CI order, exiting non-zero on the
@@ -293,6 +415,46 @@ Order comes from the `CI_ORDER` constant in `@theholocron/astromech`
293
415
  expands into its sub-jobs (each under its own `audit / …` check context)
294
416
  unless the repo ships its own `"audit"` script.
295
417
 
418
+ ### `holocron deploy`
419
+
420
+ `holocron deploy <branch>` (a Git-linked deployment) and `holocron deploy
421
+ --files <dir>` (a directory of build output, no linked repo) both trigger a
422
+ deployment through the configured `deployment` capability, then **wait for
423
+ it to finish**. The command reports success, exit code 0, only when the
424
+ deployment reaches `ready`. A deployment that ends `error` or `cancelled`,
425
+ or is still building after 10 minutes, is a failure: the exit code is
426
+ non-zero and the output includes the provider's own reason
427
+ (`DeploymentRecord.errorMessage`, e.g. Vercel's `Command "npm install"
428
+ exited with 1`). Providers build asynchronously, so accepting a deployment
429
+ isn't the same as it going live (holocron#911).
430
+
431
+ Provider plugins support this through the `Deployment` capability's
432
+ existing `getDeployment(id)`. They should set `errorMessage` on the
433
+ returned `DeploymentRecord` whenever the provider exposes one.
434
+
435
+ ### `holocron monitoring check <url>`
436
+
437
+ Runs every configured `monitoring` check against `<url>` instead of each
438
+ check's own configured `url` — no vendor API call, only a plain HTTP
439
+ request evaluated locally against the exact same `assertions` already in
440
+ `holocron.config.ts`. Built for CI: the `delivery.previewCheck` task runs
441
+ this against a PR's Vercel preview deployment (triggered by
442
+ `deployment_status`, not `push`/`pull_request`), reusing the production
443
+ check definitions to catch a breaking change before merge instead of
444
+ after (holocron#1010).
445
+
446
+ ```ts
447
+ export default defineConfig({
448
+ tasks: ["delivery.previewCheck"],
449
+ providers: {
450
+ monitoring: ["checkly", { accountId: "...", checks: [/* ... */] }],
451
+ },
452
+ });
453
+ ```
454
+
455
+ Exits non-zero if any check fails — the job's own pass/fail is what
456
+ posts as the GitHub check, no separate reporting step needed.
457
+
296
458
  ### Lint parity
297
459
 
298
460
  The `lint` task takes an optional `linters` array — one list that drives
@@ -310,7 +472,7 @@ export default defineConfig({
310
472
 
311
473
  ### Skills installer
312
474
 
313
- `holocron setup` can install shared skills from `@theholocron/skills` into the local repo:
475
+ `holocron repo setup` can install shared skills from `@theholocron/skills` into the local repo:
314
476
 
315
477
  ```ts
316
478
  export default defineConfig({
@@ -371,18 +533,92 @@ export default acmeConfig;
371
533
 
372
534
  ```
373
535
 
536
+ ## Notifications — server as code
537
+
538
+ A `notifications` provider can declare a whole server in `holocron.config.ts`
539
+ (`layout`: categories, channels, roles, access, server settings, welcome screen,
540
+ pinned messages, onboarding, the bot application) and the CLI applies and checks it. The
541
+ commands and the config are provider-neutral; Discord is the first provider.
542
+
543
+ | Command | What it does |
544
+ | -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
545
+ | `holocron notifications setup` | Applies the layout; looks everything up by name first, so a re-run changes nothing that matches |
546
+ | `holocron notifications channel add <name>` | Creates one channel (optionally with a webhook whose URL is stored as a secret) |
547
+ | `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) |
548
+ | `holocron notifications link` | Links your account on the provider to your GitHub account by signing in with the provider (OAuth, nothing secret kept) |
549
+ | `holocron notifications sync-roles` | Makes who holds a role match a GitHub team, through the links file (`--keep` only adds; `--provider` picks one) |
550
+ | `holocron doctor notifications [--built-only] [--deliver]` | 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 |
551
+ | `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 |
552
+ | `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 |
553
+ | `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 |
554
+ | `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 |
555
+ | `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 |
556
+ | `holocron probe [<provider> [<probe>]] [--dry-run] [--yes]` | 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 |
557
+
558
+ 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? }` 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`, else the layout's `webhookAvatar`). `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). 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).
559
+
560
+ 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.
561
+
562
+ `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.
563
+
564
+ `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`.
565
+
566
+ Pinned messages are declared under the provider's `layout` as `pinned: [{ channel, content }]` (`channel` is a channel in the layout, `content` up to 2000 characters); the layout is the whole set of messages the bot has pinned in those channels.
567
+
568
+ Config shape added for role sync and sign-in (all under the provider's `layout`):
569
+
570
+ | Field | Meaning |
571
+ | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
572
+ | `testChannel` | The channel (it must declare a webhook) the doctor posts its one self-removing test message to. |
573
+ | `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. |
574
+ | `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. |
575
+ | `links.localPort` | The port of the local sign-in listener (default `53682`, bound to `127.0.0.1` only). |
576
+ | `links.repo` / `links.path` | Where the links file lives (default `<org>/.github-private` and `notifications/<provider>-links.json`). |
577
+ | `application.intents.members` | Switches the Server Members Intent on or off (needed to list who holds a role). |
578
+ | `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. |
579
+
580
+ The links file is `{ "version": 1, "links": [{ "github": "<id>", "login": "<login>", "member": "<id>" }] }`: two public ids per person.
581
+ It is read and written through the `source` capability with the `github.user-sync` token (fine-grained, **only** the
582
+ private config repo, Contents read and write), so no other token needs Contents on other repositories.
583
+
584
+ Capability surface behind it (all optional, so providers without the concept omit them):
585
+
586
+ - `Source.teamMembers(teamSlug, org?)`, `Source.readFile(path, repo?)` (returns the `version` a later write must present),
587
+ `Source.writeFile(path, content, { message, version?, repo? })` (a changed `version` is refused: a real conflict check).
588
+ - `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.
589
+ - `Notifications.roleMembers(role)`, `addRoleMember(role, memberId)`, `removeRoleMember(role, memberId)`.
590
+ - `Notifications.checkDelivery({ channel, name, category?, text })`: posts through a channel's webhook, reads the post back and removes it, and says which step failed.
591
+ - `Notifications.signIn()` returning `{ authorizeUrl, complete }`: the provider-neutral shape of "prove which account you own".
592
+ - `Notifications.ensureApplication` returns `{ updated, todo? }`; each `todo` is a step only a person can do (a portal setting
593
+ the API ignores) and is reported as a failure until done.
594
+
595
+ Provider credentials for Discord: `discord.holonet` is the **bot token** (Bot → Reset Token), `discord.holonet.oauth` is the
596
+ **OAuth client secret** (OAuth2 → Reset Secret). They are different values; the API can create or read neither.
597
+
598
+ See the [command pages](https://theholocron.dev/holocron/commands/notifications-setup/) for each command's options.
599
+
600
+ ## Cleaning up
601
+
602
+ - **`holocron repo cleanup branches [--local | --remote]`** — lists the branches whose pull request is merged,
603
+ grouped, each saying whether it lives locally, on the remote or both; then asks, and offers a checklist with the
604
+ proven-merged ones ticked. Proven merged means an ancestor of `origin/alpha` or `origin/main`, or the head (or an
605
+ ancestor, or one of the commits) of a merged pull request. Branches with more commits than their merged PR, with
606
+ an open PR, checked out (here or in a worktree), or never merged are listed unticked. `--dry-run` only lists;
607
+ `--yes` deletes every proven-merged branch without asking. Pull requests and remote branches come from the
608
+ `source` provider (`Source.listPullRequests`, `listPullRequestCommits`, `listBranches`, `deleteBranch`).
609
+
374
610
  ## Upgrading
375
611
 
376
- - **`holocron upgrade node <to>`** — patches every Node.js version pin
612
+ - **`holocron repo upgrade node <to>`** — patches every Node.js version pin
377
613
  (`engines.node`, `.nvmrc`, `.node-version`, `.github/workflows/*`,
378
614
  `Dockerfile`, `.tool-versions`) to a new major.
379
- - **`holocron upgrade deps`** — bumps every `@theholocron/*` pin in
615
+ - **`holocron repo upgrade deps`** — bumps every `@theholocron/*` pin in
380
616
  `pnpm-workspace.yaml` (`catalog:` and every named `catalogs.*`) to its latest
381
617
  published version, then migrates `holocron.config.ts` from the 7.x preset
382
618
  shape (`const { repo, workflows } = node()` + `repo.requiredChecks` +
383
619
  `workflows:`) to the current composed-preset API (`const preset = node()` +
384
620
  `...preset` + `tasks:` + `extraRequiredChecks:`). Mechanical transforms only —
385
- review the result, then `pnpm install && holocron ci`. `--pins-only` skips
621
+ review the result, then `pnpm install && holocron run ci`. `--pins-only` skips
386
622
  the config migration; `--dry-run` prints without writing.
387
623
 
388
624
  ## Auth — fine-grained tokens
@@ -397,11 +633,12 @@ holocron auth set github.issues ghp_xxx # issue management
397
633
  holocron auth set github.sync ghp_xxx # sync-github workflow templates
398
634
  holocron auth set github.release ghp_xxx # semantic-release
399
635
  holocron auth set github.admin ghp_xxx # setup, secrets, environments
636
+ holocron auth set github.user-sync ghp_xxx # the files that link GitHub accounts to other services' members
400
637
  ```
401
638
 
402
639
  The resolution chain per capability is:
403
640
 
404
- ```
641
+ ```text
405
642
  --token flag → HOLOCRON_<FEATURE>_TOKEN env var → keyring("github.<feature>")
406
643
  ```
407
644
 
@@ -418,16 +655,21 @@ holocron auth list # show all stored providers
418
655
  ## Logging
419
656
 
420
657
  Operational output goes through `@theholocron/observability/logger` — separate
421
- from the user-facing `print` surface. Global flags:
658
+ from the user-facing `print` surface. Local/interactive runs are quiet by
659
+ default: no colorized or raw structured console output, regardless of the
660
+ resolved level (Axiom shipping, when configured, is unaffected). CI is
661
+ untouched — its existing stdout output still appears. Global flags:
422
662
 
423
663
  ```sh
424
- holocron doctor --verbose # log level → debug (full structured output)
425
- holocron doctor --quiet # log level → error (suppress info + warn)
664
+ holocron doctor --log debug # show console output at this level (opt back in)
665
+ holocron doctor --verbose # log level → debug, and shows console output
666
+ holocron doctor --quiet # log level → error, and shows console output
426
667
  holocron doctor --debug # print "Run ID: <uuid>" at command end for Axiom lookup
427
668
  ```
428
669
 
429
- Level resolution (highest priority first): `--verbose` / `--quiet` →
430
- `HOLOCRON_LOG_LEVEL` → `log.level` in `holocron.config` → `"info"`.
670
+ Level resolution (highest priority first): `--log <level>` → `--verbose` /
671
+ `--quiet` → `HOLOCRON_LOG_LEVEL` → `log.level` in `holocron.config` →
672
+ `"info"`.
431
673
 
432
674
  ```ts
433
675
  export default defineConfig({
@@ -439,7 +681,16 @@ Axiom shipping activates when a token (`HOLOCRON_AXIOM_TOKEN` / `AXIOM_TOKEN`
439
681
  → OS keyring `axiom.<org>` → `axiom`) **and** a dataset
440
682
  (`HOLOCRON_AXIOM_DATASET` / `AXIOM_DATASET` → `log.axiom.dataset` in
441
683
  `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/).
684
+ config file.
685
+
686
+ The dataset side of that resolution is **execution-context-aware** (ADR-0012):
687
+ a `global`-context command (`clone`, `new`, `auth set`, `upgrade node`, `plugin
688
+ create`, …) always ships to holocron's own dataset regardless of `$PWD` — it
689
+ isn't "about" any repo, so routing it through whichever repo's `.envrc`
690
+ happens to be active would be wrong. `repo-aware` / `workspace` commands
691
+ (`doctor`, `deploy`, `sync`, …) keep the env-var/config chain above, so a
692
+ per-repo `HOLOCRON_AXIOM_DATASET` — e.g. via a `.envrc` + `direnv` — separates
693
+ each consuming repo's logs. See the [logging guide](https://docs.theholocron.dev/holocron/logging/).
443
694
 
444
695
  ### Telemetry
445
696
 
@@ -468,38 +719,72 @@ export default defineConfig({
468
719
 
469
720
  Each SDK sits behind an interface from `@theholocron/observability` —
470
721
  `ErrorSink` (Sentry) / `AnalyticsSink` (PostHog); the adapters, and the only
471
- `@sentry/node` / `posthog-node` imports, live in that package. `telemetry.ts`
722
+ `@sentry/node` / `posthog-node` imports, live in that package. `observability/telemetry.ts`
472
723
  holds the orchestration + the Holocron-specific credential resolution
473
- (`telemetry/resolve.ts`). See the
724
+ (`observability/resolve-telemetry.ts`). See the
474
725
  [telemetry guide](https://docs.theholocron.dev/holocron/telemetry/).
475
726
 
727
+ ### ESLint bundle options
728
+
729
+ Most repos need nothing here — `@theholocron/eslint-config`'s `library()`
730
+ bundle resolves with zero committed file (Bucket A: `eslint --config
731
+ <shared path>`, no per-repo `eslint.config.ts` needed). A package with a
732
+ genuine, deliberate exception — e.g. Web Crypto globals a Node-targeted
733
+ package still needs, exempted via `library()`'s own `browserPackages`
734
+ option in that package's own `eslint.config.ts` — should also declare the
735
+ same paths in `holocron.config`'s `eslint.browserPackages`:
736
+
737
+ ```ts
738
+ export default defineConfig({
739
+ eslint: {
740
+ browserPackages: ["clients/github-client/src/app-auth"],
741
+ },
742
+ });
743
+ ```
744
+
745
+ This doesn't replace the package's own `eslint.config.ts` (local/CI linting
746
+ still resolves that file directly) — it's the signal Sentinel's centralized
747
+ static-analysis check (holocron#849/#858) reads instead, since that check
748
+ never reads a PR's own committed config files. Without it, Sentinel flags a
749
+ false-positive `eslint-plugin-n` node-builtins finding on exactly the files
750
+ the local override exists to exempt.
751
+
476
752
  ## What's in here
477
753
 
478
- - `src/capabilities/` — the 14 capability interfaces that providers
479
- implement
754
+ - `src/plugin/capabilities.ts` — the 18 capability interfaces that
755
+ providers implement
480
756
  - `src/config.ts` — config schema, `defineConfig`, `resolveConfig`,
481
757
  `CapabilityConfigPackage`
482
758
  - `src/config/load-config.ts` — `loadConfig` — reads `holocron.config.*`
483
759
  (file discovery via [`@theholocron/datapad`](../datapad))
484
760
  - `src/define-config.ts` — `defineConfig` typed pass-through
485
- - `src/logger.ts` — CLI-side `@theholocron/observability/logger` wiring
761
+ - `src/observability/logger.ts` — CLI-side `@theholocron/observability/logger` wiring
486
762
  (`buildCliLogger`, `resolveLogLevel`)
487
763
  - `src/loader.ts` — `PluginLoader` — dynamic-imports plugins, resolves
488
764
  capability config packages, builds the capability registry
489
765
  - `src/cli.ts` — yargs entry, dispatches subcommands. `holocron run` / `ci` are
490
766
  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
767
+ `holocron repo sync` / `holocron repo setup` write each repo's `.github/workflows/*.yml`
768
+ thin callers from `astromech.thinCallers()`; `holocron sync github` pushes the
493
769
  reusable `workflow_call` implementations + composite actions from
494
770
  `astromech.reusableTemplates()` to `theholocron/.github` (a pure sync target —
495
771
  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)
772
+ - `src/commands/` — `repo setup`, `repo sync`, `doctor`, `deploy`,
773
+ `monitoring check`, `secrets list`, `secrets set`, `secrets sync`, `package publish`,
774
+ `package bump-versions`, `sync github`, `repo upgrade node`,
775
+ `repo upgrade deps`, `new plugin`, `auth`, `notifications setup`,
776
+ `notifications channel add`, `notifications link`,
777
+ `notifications sync-roles`, `doctor environments`, `doctor notifications`, `doctor secrets`, `doctor tokens`, `doctor variables`
778
+ - `src/commands/doctor-checks/` and `src/commands/deep-checks/` — the shared row
779
+ renderer and `declaredVsActual` helper, and `DEEP_CHECKS`, the registry every
780
+ `doctor <capability>` is listed in
781
+ - `src/interactive-menu/` — the interactive fallback: `command-registry`
782
+ (`COMMAND_REGISTRY`, each entry's `positionals`/`options`), `launch-menu`
783
+ (Layers 1–2, picks + spawns a fresh `holocron <command>`), `child-argv`
784
+ (builds the spawned argv + secret env), `menu-items`, `run-menu-entries`.
785
+ The generic prompting pieces it calls — `promptForPositionals`,
786
+ `promptForOptions` (Layer 3) — live in `src/ui/`, which has no knowledge
787
+ of commands.
503
788
 
504
789
  ## Status
505
790