@theholocron/cli 5.0.0-alpha.28 → 5.0.0-alpha.280

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?, 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; 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
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,11 +271,45 @@ 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
193
- an existing repo.
277
+ required check that never posts. It also ignores `**/*.mdx`, so a docs-only PR that
278
+ adds pages is not judged to change testable files and left with an empty upload.
279
+ A re-run of `holocron repo setup` backfills all of these into an existing repo.
280
+
281
+ ### Default branch (`repo.defaultBranch`)
282
+
283
+ ```ts
284
+ export default defineConfig({
285
+ repo: { protection: "strict", defaultBranch: "alpha" },
286
+ providers: { source: "github" },
287
+ });
288
+ ```
289
+
290
+ `holocron repo setup` syncs GitHub's repo-level default branch (`HEAD`) — what a
291
+ fresh clone checks out, what `gh pr create`/the compare UI target by default,
292
+ and what Sentinel's `validateConfig()` reads (it only ever reads config from
293
+ the repo's default branch, never a PR ref — a deliberate security boundary).
294
+ Omit this field to leave GitHub's current setting untouched; most repos never
295
+ need it. It exists for a repo using a `main`/`alpha` prerelease-channel split
296
+ where active development happens on a non-`main` branch: set this to that
297
+ branch so Sentinel validates against what's actually being developed, then
298
+ change it back once that branch merges to `main` for a stable cut and stops
299
+ being the active branch.
300
+
301
+ ### Doc-comment coverage
302
+
303
+ ```ts
304
+ export default defineConfig({
305
+ repoValidation: { docsCoverage: "required" }, // "off" (default) | "warn" | "required"
306
+ });
307
+ ```
308
+
309
+ Controls `holocron probe docs patch` (skipped, reports without failing, or fails for an export a PR adds or changes
310
+ without a doc comment) and whether `holocron repo setup` adds the `documentation` flag and its statuses to
311
+ `codecov.yml`, informational for `"warn"`. It never touches the required checks. See the
312
+ [config docs](https://docs.theholocron.dev/holocron/config/#doc-comment-coverage).
194
313
 
195
314
  ### Git hooks
196
315
 
@@ -202,7 +321,7 @@ export default defineConfig({
202
321
  });
203
322
  ```
204
323
 
205
- `holocron setup` writes `.husky/pre-push` (runs `holocron ci` before every
324
+ `holocron repo setup` writes `.husky/pre-push` (runs `holocron run ci` before every
206
325
  push) and `.husky/pre-commit` (runs `gitleaks protect --staged` + `lint-staged`
207
326
  before every commit — scoped to staged changes, not the whole history, so a
208
327
  past false positive can't permanently block future commits) and sets
@@ -213,14 +332,14 @@ setup --hooks` / `--no-hooks` override per run. Bypass one push with `git push
213
332
 
214
333
  ### Task scripts
215
334
 
216
- `holocron sync` reconciles `package.json#scripts` from the `tasks` manifest
335
+ `holocron repo sync` reconciles `package.json#scripts` from the `tasks` manifest
217
336
  (merge, never clobber — only the managed keys are touched):
218
337
 
219
338
  ```ts
220
339
  export default defineConfig({
221
340
  tasks: ["test", "lint", "typecheck"],
222
341
  // syncScripts: false, // disable the step
223
- // holocronScript: "node packages/cli/dist/cli.mjs", // override the "holocron" entry
342
+ // holocronScript: "node cli/cli/dist/cli.mjs", // override the "holocron" entry
224
343
  providers: { source: "github" },
225
344
  });
226
345
  ```
@@ -248,8 +367,8 @@ export default defineConfig({
248
367
  `@theholocron/astromech`'s `loadTasksConfig` merges it over
249
368
  `holocron.config`'s `tasks` — **task arrays concatenate**
250
369
  (`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
370
+ `extraRequiredChecks` concatenate. `holocron run` / `holocron run ci` /
371
+ `holocron repo setup` / `holocron repo sync` all read the merged result, so the
253
372
  split is transparent. Useful for keeping the capability/provider config
254
373
  and the "what this repo runs" manifest in separate files (this repo does).
255
374
 
@@ -276,10 +395,27 @@ job execute the same thing — at a turbo root both are
276
395
  `turbo run test -- --coverage` (the registry's org-default flags flow through
277
396
  turbo's `--`).
278
397
 
279
- ### `holocron ci`
398
+ ### `holocron deploy on-release`
280
399
 
281
400
  ```bash
282
- holocron ci [--all] [--filter <pkg>] [--dry-run]
401
+ holocron deploy on-release [--channel <alpha|main>] [--from <commit>] [--to <commit>] [--dry-run]
402
+ ```
403
+
404
+ Deploys every workspace package whose own `holocron.config` declares
405
+ `{ name: "delivery.deploy", with: { on: "release" } }` (holocron#930), when the
406
+ release (`--channel`: its prerelease identifier, or `main`/empty for a stable
407
+ release) is on the task's `channel` (default `main`, the stable release) and changes the package or one of its
408
+ `workspace:*` dependencies between `--from` (the previous release's commit,
409
+ omitted when there is none) and `--to` (default `HEAD`). It waits for npm to
410
+ serve the release's new dependency versions, then runs `pnpm --filter <pkg>
411
+ delivery.deploy`. A package that doesn't apply is skipped; a deploy that
412
+ doesn't succeed exits non-zero. The shared `delivery.publish` workflow runs it as its own
413
+ `deploy` job after the release job (opt in with `deploy-on-release: true`).
414
+
415
+ ### `holocron run ci`
416
+
417
+ ```bash
418
+ holocron run ci [--all] [--filter <pkg>] [--dry-run]
283
419
  ```
284
420
 
285
421
  Runs the merge-gating checks locally, in CI order, exiting non-zero on the
@@ -293,6 +429,46 @@ Order comes from the `CI_ORDER` constant in `@theholocron/astromech`
293
429
  expands into its sub-jobs (each under its own `audit / …` check context)
294
430
  unless the repo ships its own `"audit"` script.
295
431
 
432
+ ### `holocron deploy`
433
+
434
+ `holocron deploy <branch>` (a Git-linked deployment) and `holocron deploy
435
+ --files <dir>` (a directory of build output, no linked repo) both trigger a
436
+ deployment through the configured `deployment` capability, then **wait for
437
+ it to finish**. The command reports success, exit code 0, only when the
438
+ deployment reaches `ready`. A deployment that ends `error` or `cancelled`,
439
+ or is still building after 10 minutes, is a failure: the exit code is
440
+ non-zero and the output includes the provider's own reason
441
+ (`DeploymentRecord.errorMessage`, e.g. Vercel's `Command "npm install"
442
+ exited with 1`). Providers build asynchronously, so accepting a deployment
443
+ isn't the same as it going live (holocron#911).
444
+
445
+ Provider plugins support this through the `Deployment` capability's
446
+ existing `getDeployment(id)`. They should set `errorMessage` on the
447
+ returned `DeploymentRecord` whenever the provider exposes one.
448
+
449
+ ### `holocron monitoring check <url>`
450
+
451
+ Runs every configured `monitoring` check against `<url>` instead of each
452
+ check's own configured `url` — no vendor API call, only a plain HTTP
453
+ request evaluated locally against the exact same `assertions` already in
454
+ `holocron.config.ts`. Built for CI: the `delivery.previewCheck` task runs
455
+ this against a PR's Vercel preview deployment (triggered by
456
+ `deployment_status`, not `push`/`pull_request`), reusing the production
457
+ check definitions to catch a breaking change before merge instead of
458
+ after (holocron#1010).
459
+
460
+ ```ts
461
+ export default defineConfig({
462
+ tasks: ["delivery.previewCheck"],
463
+ providers: {
464
+ monitoring: ["checkly", { accountId: "...", checks: [/* ... */] }],
465
+ },
466
+ });
467
+ ```
468
+
469
+ Exits non-zero if any check fails — the job's own pass/fail is what
470
+ posts as the GitHub check, no separate reporting step needed.
471
+
296
472
  ### Lint parity
297
473
 
298
474
  The `lint` task takes an optional `linters` array — one list that drives
@@ -310,7 +486,7 @@ export default defineConfig({
310
486
 
311
487
  ### Skills installer
312
488
 
313
- `holocron setup` can install shared skills from `@theholocron/skills` into the local repo:
489
+ `holocron repo setup` can install shared skills from `@theholocron/skills` into the local repo:
314
490
 
315
491
  ```ts
316
492
  export default defineConfig({
@@ -371,18 +547,95 @@ export default acmeConfig;
371
547
 
372
548
  ```
373
549
 
550
+ ## Notifications — server as code
551
+
552
+ A `notifications` provider can declare a whole server in `holocron.config.ts`
553
+ (`layout`: categories, channels, roles, access, server settings, welcome screen,
554
+ pinned messages, onboarding, the bot application) and the CLI applies and checks it. The
555
+ commands and the config are provider-neutral; Discord is the first provider.
556
+
557
+ | Command | What it does |
558
+ | --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
559
+ | `holocron notifications setup` | Applies the layout; looks everything up by name first, so a re-run changes nothing that matches |
560
+ | `holocron notifications channel add <name>` | Creates one channel (optionally with a webhook whose URL is stored as a secret) |
561
+ | `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) |
562
+ | `holocron notifications link` | Links your account on the provider to your GitHub account by signing in with the provider (OAuth, nothing secret kept) |
563
+ | `holocron notifications sync-roles` | Makes who holds a role match a GitHub team, through the links file (`--keep` only adds; `--provider` picks one) |
564
+ | `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. It also reads the Checkly feed (webhook, alert channel, subscriptions) and the Comlink relay (Worker, route, bindings, the tracker's integration and rule), posting nothing, so `--built-only` keeps those steps |
565
+ | `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 |
566
+ | `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 |
567
+ | `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 |
568
+ | `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 |
569
+ | `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 |
570
+ | `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 |
571
+ | `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 |
572
+ | `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 |
573
+ | `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 |
574
+
575
+ 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).
576
+
577
+ 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.
578
+
579
+ `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.
580
+
581
+ `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`.
582
+
583
+ 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.
584
+
585
+ Config shape added for role sync and sign-in (all under the provider's `layout`):
586
+
587
+ | Field | Meaning |
588
+ | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
589
+ | `testChannel` | The channel (it must declare a webhook) the doctor posts its one self-removing test message to. |
590
+ | `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. |
591
+ | `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. |
592
+ | `links.localPort` | The port of the local sign-in listener (default `53682`, bound to `127.0.0.1` only). |
593
+ | `links.repo` / `links.path` | Where the links file lives (default `<org>/.github-private` and `notifications/<provider>-links.json`). |
594
+ | `application.intents.members` | Switches the Server Members Intent on or off (needed to list who holds a role). |
595
+ | `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. |
596
+
597
+ The links file is `{ "version": 1, "links": [{ "github": "<id>", "login": "<login>", "member": "<id>" }] }`: two public ids per person.
598
+ It is read and written through the `source` capability with the `github.user-sync` token (fine-grained, **only** the
599
+ private config repo, Contents read and write), so no other token needs Contents on other repositories.
600
+
601
+ Capability surface behind it (all optional, so providers without the concept omit them):
602
+
603
+ - `Source.teamMembers(teamSlug, org?)`, `Source.readFile(path, repo?)` (returns the `version` a later write must present),
604
+ `Source.writeFile(path, content, { message, version?, repo? })` (a changed `version` is refused: a real conflict check).
605
+ - `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.
606
+ - `Notifications.roleMembers(role)`, `addRoleMember(role, memberId)`, `removeRoleMember(role, memberId)`.
607
+ - `Notifications.checkDelivery({ channel, name, category?, text })`: posts through a channel's webhook, reads the post back and removes it, and says which step failed.
608
+ - `Notifications.signIn()` returning `{ authorizeUrl, complete }`: the provider-neutral shape of "prove which account you own".
609
+ - `Notifications.ensureApplication` returns `{ updated, todo? }`; each `todo` is a step only a person can do (a portal setting
610
+ the API ignores) and is reported as a failure until done.
611
+
612
+ Provider credentials for Discord: `discord.holonet` is the **bot token** (Bot → Reset Token), `discord.holonet.oauth` is the
613
+ **OAuth client secret** (OAuth2 → Reset Secret). They are different values; the API can create or read neither.
614
+
615
+ See the [command pages](https://theholocron.dev/holocron/commands/notifications-setup/) for each command's options.
616
+
617
+ ## Cleaning up
618
+
619
+ - **`holocron repo cleanup branches [--local | --remote]`** — lists the branches whose pull request is merged,
620
+ grouped, each saying whether it lives locally, on the remote or both; then asks, and offers a checklist with the
621
+ proven-merged ones ticked. Proven merged means an ancestor of `origin/alpha` or `origin/main`, or the head (or an
622
+ ancestor, or one of the commits) of a merged pull request. Branches with more commits than their merged PR, with
623
+ an open PR, checked out (here or in a worktree), or never merged are listed unticked. `--dry-run` only lists;
624
+ `--yes` deletes every proven-merged branch without asking. Pull requests and remote branches come from the
625
+ `source` provider (`Source.listPullRequests`, `listPullRequestCommits`, `listBranches`, `deleteBranch`).
626
+
374
627
  ## Upgrading
375
628
 
376
- - **`holocron upgrade node <to>`** — patches every Node.js version pin
629
+ - **`holocron repo upgrade node <to>`** — patches every Node.js version pin
377
630
  (`engines.node`, `.nvmrc`, `.node-version`, `.github/workflows/*`,
378
631
  `Dockerfile`, `.tool-versions`) to a new major.
379
- - **`holocron upgrade deps`** — bumps every `@theholocron/*` pin in
632
+ - **`holocron repo upgrade deps`** — bumps every `@theholocron/*` pin in
380
633
  `pnpm-workspace.yaml` (`catalog:` and every named `catalogs.*`) to its latest
381
634
  published version, then migrates `holocron.config.ts` from the 7.x preset
382
635
  shape (`const { repo, workflows } = node()` + `repo.requiredChecks` +
383
636
  `workflows:`) to the current composed-preset API (`const preset = node()` +
384
637
  `...preset` + `tasks:` + `extraRequiredChecks:`). Mechanical transforms only —
385
- review the result, then `pnpm install && holocron ci`. `--pins-only` skips
638
+ review the result, then `pnpm install && holocron run ci`. `--pins-only` skips
386
639
  the config migration; `--dry-run` prints without writing.
387
640
 
388
641
  ## Auth — fine-grained tokens
@@ -397,11 +650,12 @@ holocron auth set github.issues ghp_xxx # issue management
397
650
  holocron auth set github.sync ghp_xxx # sync-github workflow templates
398
651
  holocron auth set github.release ghp_xxx # semantic-release
399
652
  holocron auth set github.admin ghp_xxx # setup, secrets, environments
653
+ holocron auth set github.user-sync ghp_xxx # the files that link GitHub accounts to other services' members
400
654
  ```
401
655
 
402
656
  The resolution chain per capability is:
403
657
 
404
- ```
658
+ ```text
405
659
  --token flag → HOLOCRON_<FEATURE>_TOKEN env var → keyring("github.<feature>")
406
660
  ```
407
661
 
@@ -418,16 +672,21 @@ holocron auth list # show all stored providers
418
672
  ## Logging
419
673
 
420
674
  Operational output goes through `@theholocron/observability/logger` — separate
421
- from the user-facing `print` surface. Global flags:
675
+ from the user-facing `print` surface. Local/interactive runs are quiet by
676
+ default: no colorized or raw structured console output, regardless of the
677
+ resolved level (Axiom shipping, when configured, is unaffected). CI is
678
+ untouched — its existing stdout output still appears. Global flags:
422
679
 
423
680
  ```sh
424
- holocron doctor --verbose # log level → debug (full structured output)
425
- holocron doctor --quiet # log level → error (suppress info + warn)
681
+ holocron doctor --log debug # show console output at this level (opt back in)
682
+ holocron doctor --verbose # log level → debug, and shows console output
683
+ holocron doctor --quiet # log level → error, and shows console output
426
684
  holocron doctor --debug # print "Run ID: <uuid>" at command end for Axiom lookup
427
685
  ```
428
686
 
429
- Level resolution (highest priority first): `--verbose` / `--quiet` →
430
- `HOLOCRON_LOG_LEVEL` → `log.level` in `holocron.config` → `"info"`.
687
+ Level resolution (highest priority first): `--log <level>` → `--verbose` /
688
+ `--quiet` → `HOLOCRON_LOG_LEVEL` → `log.level` in `holocron.config` →
689
+ `"info"`.
431
690
 
432
691
  ```ts
433
692
  export default defineConfig({
@@ -439,7 +698,16 @@ Axiom shipping activates when a token (`HOLOCRON_AXIOM_TOKEN` / `AXIOM_TOKEN`
439
698
  → OS keyring `axiom.<org>` → `axiom`) **and** a dataset
440
699
  (`HOLOCRON_AXIOM_DATASET` / `AXIOM_DATASET` → `log.axiom.dataset` in
441
700
  `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/).
701
+ config file.
702
+
703
+ The dataset side of that resolution is **execution-context-aware** (ADR-0012):
704
+ a `global`-context command (`clone`, `new`, `auth set`, `upgrade node`, `plugin
705
+ create`, …) always ships to holocron's own dataset regardless of `$PWD` — it
706
+ isn't "about" any repo, so routing it through whichever repo's `.envrc`
707
+ happens to be active would be wrong. `repo-aware` / `workspace` commands
708
+ (`doctor`, `deploy`, `sync`, …) keep the env-var/config chain above, so a
709
+ per-repo `HOLOCRON_AXIOM_DATASET` — e.g. via a `.envrc` + `direnv` — separates
710
+ each consuming repo's logs. See the [logging guide](https://docs.theholocron.dev/holocron/logging/).
443
711
 
444
712
  ### Telemetry
445
713
 
@@ -468,38 +736,72 @@ export default defineConfig({
468
736
 
469
737
  Each SDK sits behind an interface from `@theholocron/observability` —
470
738
  `ErrorSink` (Sentry) / `AnalyticsSink` (PostHog); the adapters, and the only
471
- `@sentry/node` / `posthog-node` imports, live in that package. `telemetry.ts`
739
+ `@sentry/node` / `posthog-node` imports, live in that package. `observability/telemetry.ts`
472
740
  holds the orchestration + the Holocron-specific credential resolution
473
- (`telemetry/resolve.ts`). See the
741
+ (`observability/resolve-telemetry.ts`). See the
474
742
  [telemetry guide](https://docs.theholocron.dev/holocron/telemetry/).
475
743
 
744
+ ### ESLint bundle options
745
+
746
+ Most repos need nothing here — `@theholocron/eslint-config`'s `library()`
747
+ bundle resolves with zero committed file (Bucket A: `eslint --config
748
+ <shared path>`, no per-repo `eslint.config.ts` needed). A package with a
749
+ genuine, deliberate exception — e.g. Web Crypto globals a Node-targeted
750
+ package still needs, exempted via `library()`'s own `browserPackages`
751
+ option in that package's own `eslint.config.ts` — should also declare the
752
+ same paths in `holocron.config`'s `eslint.browserPackages`:
753
+
754
+ ```ts
755
+ export default defineConfig({
756
+ eslint: {
757
+ browserPackages: ["clients/github-client/src/app-auth"],
758
+ },
759
+ });
760
+ ```
761
+
762
+ This doesn't replace the package's own `eslint.config.ts` (local/CI linting
763
+ still resolves that file directly) — it's the signal Sentinel's centralized
764
+ static-analysis check (holocron#849/#858) reads instead, since that check
765
+ never reads a PR's own committed config files. Without it, Sentinel flags a
766
+ false-positive `eslint-plugin-n` node-builtins finding on exactly the files
767
+ the local override exists to exempt.
768
+
476
769
  ## What's in here
477
770
 
478
- - `src/capabilities/` — the 14 capability interfaces that providers
479
- implement
771
+ - `src/plugin/capabilities.ts` — the 18 capability interfaces that
772
+ providers implement
480
773
  - `src/config.ts` — config schema, `defineConfig`, `resolveConfig`,
481
774
  `CapabilityConfigPackage`
482
775
  - `src/config/load-config.ts` — `loadConfig` — reads `holocron.config.*`
483
776
  (file discovery via [`@theholocron/datapad`](../datapad))
484
777
  - `src/define-config.ts` — `defineConfig` typed pass-through
485
- - `src/logger.ts` — CLI-side `@theholocron/observability/logger` wiring
778
+ - `src/observability/logger.ts` — CLI-side `@theholocron/observability/logger` wiring
486
779
  (`buildCliLogger`, `resolveLogLevel`)
487
780
  - `src/loader.ts` — `PluginLoader` — dynamic-imports plugins, resolves
488
781
  capability config packages, builds the capability registry
489
782
  - `src/cli.ts` — yargs entry, dispatches subcommands. `holocron run` / `ci` are
490
783
  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
784
+ `holocron repo sync` / `holocron repo setup` write each repo's `.github/workflows/*.yml`
785
+ thin callers from `astromech.thinCallers()`; `holocron sync github` pushes the
493
786
  reusable `workflow_call` implementations + composite actions from
494
787
  `astromech.reusableTemplates()` to `theholocron/.github` (a pure sync target —
495
788
  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)
789
+ - `src/commands/` — `repo setup`, `repo sync`, `doctor`, `deploy`,
790
+ `monitoring check`, `secrets list`, `secrets set`, `secrets sync`, `package publish`,
791
+ `package bump-versions`, `sync github`, `repo upgrade node`,
792
+ `repo upgrade deps`, `new plugin`, `auth`, `notifications setup`,
793
+ `notifications channel add`, `notifications link`,
794
+ `notifications sync-roles`, `doctor dns`, `doctor environments`, `doctor monitoring`, `doctor notifications`, `doctor repo`, `doctor secrets`, `doctor tokens`, `doctor variables`
795
+ - `src/commands/doctor-checks/` and `src/commands/deep-checks/` — the shared row
796
+ renderer and `declaredVsActual` helper, and `DEEP_CHECKS`, the registry every
797
+ `doctor <capability>` is listed in
798
+ - `src/interactive-menu/` — the interactive fallback: `command-registry`
799
+ (`COMMAND_REGISTRY`, each entry's `positionals`/`options`), `launch-menu`
800
+ (Layers 1–2, picks + spawns a fresh `holocron <command>`), `child-argv`
801
+ (builds the spawned argv + secret env), `menu-items`, `run-menu-entries`.
802
+ The generic prompting pieces it calls — `promptForPositionals`,
803
+ `promptForOptions` (Layer 3) — live in `src/ui/`, which has no knowledge
804
+ of commands.
503
805
 
504
806
  ## Status
505
807