@theholocron/cli 2.0.0-alpha.6 → 2.0.0-alpha.61

package/README.md

@@ -1,3 +1,5 @@
+<!-- editorconfig-checker-disable-file -->
+
 # `@theholocron/cli`
 
 The Holocron CLI — a pluggable, capability-based orchestrator for
@@ -5,24 +7,129 @@ spinning up and operating software projects.
 
 ## Install
 
+<!-- prettier-ignore -->
 ```bash
 npm i -g @theholocron/cli@alpha
 holocron --help
+
+```
+
+## Config file
+
+Holocron reads `holocron.config.{json,js,ts}` from the project root
+(priority: json → js → ts).
+
+**JSON** (simplest):
+
+<!-- prettier-ignore -->
+```jsonc
+// holocron.config.json
+{
+  "name": "my-app",
+  "providers": {
+    "vault": ["1password", { "vault": "my-app" }],
+    "source": "github",
+  },
+}
+
+```
+
+**JS/TS** — use `defineConfig` for autocomplete and type-checking:
+
+<!-- prettier-ignore -->
+```ts
+// holocron.config.ts
+import { defineConfig } from "@theholocron/cli";
+
+export default defineConfig({
+  name: "my-app",
+  providers: {
+    vault: ["1password", { vault: "my-app" }],
+    source: "github",
+  },
+});
+
+```
+
+### Auto-derived fields
+
+`name` and `repo.name` are optional. When absent, Holocron fills them
+in at load time:
+
+| Field       | Derived from                                         | Fallback           |
+| ----------- | ---------------------------------------------------- | ------------------ |
+| `name`      | `package.json` → `name` field (scope stripped)       | directory basename |
+| `repo.name` | `git remote get-url origin` (parsed to `owner/repo`) | not set            |
+
+A minimal config — for repos with a `package.json` and a GitHub remote
+— only needs `providers`:
+
+<!-- prettier-ignore -->
+```jsonc
+{ "providers": { "source": "github" } }
+```
+
+Set `name` explicitly whenever the derived value would be wrong: content
+repos without a `package.json` (e.g. `.github`) will fall back to the
+directory basename, which may not match what your vault or deployment
+provider expects as a project identifier.
+
+### Shareable configs
+
+**Level 1 — per-capability config packages.** Reference a published
+package in any provider slot and Holocron resolves its bundled
+`{ provider, options }` automatically. Per-project options merge on
+top (project wins):
+
+<!-- prettier-ignore -->
+```ts
+providers: {
+  vault: '@acme/holocron-vault',                     // preset only
+  source: ['@acme/holocron-github', { repo: 'x' }], // preset + override
+}
+
+```
+
+A capability config package exports a `CapabilityConfigPackage` default:
+
+<!-- prettier-ignore -->
+```ts
+import type { CapabilityConfigPackage } from "@theholocron/cli";
+export default {
+  provider: "1password",
+  options: { vault: "acme-app" },
+} satisfies CapabilityConfigPackage;
+
+```
+
+**Level 2 — whole-config presets.** Because the config file can be
+JS/TS, a shared base is just an import:
+
+<!-- prettier-ignore -->
+```ts
+// holocron.config.ts
+import { acmeConfig } from "@acme/holocron-config";
+export default acmeConfig;
+
 ```
 
 ## What's in here
 
 - `src/capabilities/` — the 14 capability interfaces that providers
-	implement
-- `src/config.ts` — `holocron.config.json` parser + plugin resolution
+  implement
+- `src/config.ts` — config schema, `defineConfig`, `resolveConfig`,
+  `CapabilityConfigPackage`
+- `src/load-config.ts` — `loadConfig` — reads JSON/JS/TS config files
+- `src/define-config.ts` — `defineConfig` typed pass-through
+- `src/loader.ts` — `PluginLoader` — dynamic-imports plugins, resolves
+  capability config packages, builds the capability registry
 - `src/cli.ts` — yargs entry, dispatches subcommands
-- `src/commands/` — `setup`, `doctor`, `deploy`, `secret set`,
-	`secrets sync`, `npm publish-initial`
+- `src/commands/` — `setup`, `sync`, `doctor`, `deploy`, `secret set`,
+  `secrets sync`, `npm publish-initial`, `sync-github`, `upgrade node`,
+  `plugin create`, `auth`
 
 ## Status
 
-**`v2.0.0-alpha.0`** — published on npm under the `alpha` dist-tag.
-[Release notes](https://github.com/theholocron/holocron/releases/tag/v2.0.0-alpha.0).
-Design in
-[`.notes/tech-architecture.spec.md`](../../.notes/tech-architecture.spec.md).
-APIs may still shift before stable v2.0.0.
+Published on npm under the `alpha` dist-tag. APIs may still shift before
+stable v2.0.0. Design in
+[`.notes/archive/tech-architecture.spec.md`](../../.notes/archive/tech-architecture.spec.md).