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