honestdocs 0.1.1 → 0.1.3

package/README.md

@@ -10,6 +10,7 @@
 </p>
 
 <p align="center">
+  <a href="https://www.npmjs.com/package/honestdocs"><img alt="npm version" src="https://img.shields.io/npm/v/honestdocs?label=npm&color=1f2328"></a>
   <a href="LICENSE"><img alt="MIT license" src="https://img.shields.io/badge/license-MIT-16a34a"></a>
   <img alt="Node 20+ or Bun" src="https://img.shields.io/badge/node-%E2%89%A520%20%C2%B7%20bun-1f2328">
   <img alt="Zero dependencies" src="https://img.shields.io/badge/dependencies-0-1f2328">
@@ -287,6 +288,7 @@ Markdown, so your own documents are never overwritten.
     "rules": "Standing rules every change must keep"
   },
   "trailer": "Doc",                       // the commit trailer key
+  "command": "npx honestdocs",            // how this project runs it (see below)
   "codeRepos": ["."],                     // where trailer commits are read from
   "templates": ".honestdocs/_templates",  // optional: your own <type>.md templates
   "types": {                              // optional: add or remove types
@@ -298,6 +300,12 @@ Markdown, so your own documents are never overwritten.
 }
 ```
 
+`command` is what honestdocs writes into `AGENTS.md`, the skill and its own messages
+whenever it tells someone to run it. `init` records the runner that started it —
+`bunx honestdocs` under Bun, `pnpm dlx honestdocs` under pnpm, otherwise `npx honestdocs` —
+and never a bare `honestdocs`, which exists only where someone installed it globally.
+Change it, then `init --agents` (and `--skill`) to rewrite those sections.
+
 Templates may use `{{title}}`, `{{id}}` and `{{date}}`. Write the bodies in any language;
 filenames and frontmatter stay plain ASCII so every tool can read them.
 

package/guide/METHOD.md

@@ -18,7 +18,7 @@ what keep it right. The `honestdocs` command enforces the ones a machine can che
 - **D2 A field someone has to remember to update will be wrong.** So people write four
   fields — `title`, `status`, `supersedes`, `related` — and everything else is derived:
   `progress` from the checklist, `files` from git, `superseded-by` from the newer
-  document, `updated` from git. `honestdocs index` derives; nobody types those.
+  document, `updated` from git. `{{command}} index` derives; nobody types those.
 
 - **D3 Write it down before building.** Non-trivial work starts with a document: a design
   for "how should this work", a plan for "what are the steps", research for "what is
@@ -32,7 +32,7 @@ what keep it right. The `honestdocs` command enforces the ones a machine can che
 - **D5 Write down what was rejected.** Every template has *Alternatives considered*. The
   option that lost, and why, is what stops the same argument three months later — and
   stops an AI agent from proposing it again as if it were new. Before proposing a design,
-  search for it: `honestdocs search <words> --section alternatives`.
+  search for it: `{{command}} search <words> --section alternatives`.
 
 - **D6 One document replaces another from the newer side.** Write
   `supersedes: [<old id>]` in the new document; the old one is marked automatically.
@@ -48,7 +48,7 @@ what keep it right. The `honestdocs` command enforces the ones a machine can che
   truths.
 
 - **D9 A rule that can be a test is one.** Rules are numbered (`R1`, `R2`, …) so they can
-  be cited in a review. A rule names the test that proves it, and `honestdocs check`
+  be cited in a review. A rule names the test that proves it, and `{{command}} check`
   fails when that test file is gone. A rule that lives only in prose is the one that gets
   forgotten.
 

package/guide/agents-snippet.md

@@ -4,19 +4,19 @@ This project keeps its decisions, plans, research, postmortems and standing rule
 `{{root}}/`, managed by `honestdocs`. The code is the truth: where a document and the code
 disagree, believe the code and correct the document's status.
 
-- **Starting a session:** run `honestdocs brief` — what is in progress, its next unticked
+- **Starting a session:** run `{{command}} brief` — what is in progress, its next unticked
   items, what changed lately, which rules are in force.
-- **Before building anything non-trivial:** run `honestdocs search <words>` (add
+- **Before building anything non-trivial:** run `{{command}} search <words>` (add
   `--section alternatives` to see what was already rejected, and why), read the rules a
-  change touches (`honestdocs rules`), then open a document:
-  `honestdocs new <area> <slug> --type design|plan|research --title "…"`.
+  change touches (`{{command}} rules`), then open a document:
+  `{{command}} new <area> <slug> --type design|plan|research --title "…"`.
 - **While building:** put `{{trailer}}: <id>` on its own line at the end of every commit
   message that does the work. Tick the document's checklist as items land; add dated
   notes to its Log — they are the hand-over to the next session.
-- **Never type** `progress`, `files`, `superseded-by` or `updated` — `honestdocs index`
+- **Never type** `progress`, `files`, `superseded-by` or `updated` — `{{command}} index`
   derives them. To replace a document, write `supersedes: [<old id>]` in the new one.
-- **Finishing:** `honestdocs done <id>` (or `--abandoned`, with the reason in the Log),
-  then `honestdocs check`. A change is not finished while a document or rule it affects
+- **Finishing:** `{{command}} done <id>` (or `--abandoned`, with the reason in the Log),
+  then `{{command}} check`. A change is not finished while a document or rule it affects
   still describes the old behaviour.
 - Ids are filenames and never change. Add `--json` to any query command for
-  machine-readable output. The full method: `honestdocs guide`.
+  machine-readable output. The full method: `{{command}} guide`.

package/guide/before-you-build.md

@@ -18,7 +18,7 @@ is finished.
 - **B2** A change is not finished while a document or rule it affects still describes the
   old behaviour.
 - **B3** A rule that can be checked by a test names that test on a `Test:` line, so
-  `honestdocs check` notices when it disappears.
+  `{{command}} check` notices when it disappears.
 
 ## The checklist
 
@@ -27,18 +27,18 @@ public API, a setting — each pointing at the rule document that governs it. St
 add a line the first time something is forgotten._
 
 **Any change**
-- ☐ Searched for earlier decisions: `honestdocs search <words> --section alternatives`.
+- ☐ Searched for earlier decisions: `{{command}} search <words> --section alternatives`.
 - ☐ The documents and rules it affects are updated in the same batch (B2).
 
 **Before saying it works**
 - ☐ The project's tests pass.
-- ☐ `honestdocs index && honestdocs check` passes.
+- ☐ `{{command}} index && {{command}} check` passes.
 
 ## Keeping this folder right
 
 - A rule changes ⇒ edit its document here, in place, and add a line to its Log.
 - A new cross-cutting concern ⇒ a new rule document
-  (`honestdocs new rules <slug> --type rule --status current --title "…"`), its rules
+  (`{{command}} new rules <slug> --type rule --status current --title "…"`), its rules
   numbered with a fresh letter, and its lines added to the checklist above.
 
 ## Log

package/guide/docs-readme.md

@@ -14,11 +14,16 @@ the code disagree, believe the code — then come back and correct the document'
 ## Working with them
 
 ```sh
-honestdocs brief                                  # what is under way
-honestdocs new <area> <slug> --type plan --title "…"
-git commit -m "…" -m "{{trailer}}: <id>"                    # link the work to its document
-honestdocs done <id>                              # close it
-honestdocs index && honestdocs check              # derive, regenerate, validate
+# what is under way
+{{command}} brief
+# start a document
+{{command}} new <area> <slug> --type plan --title "…"
+# link the work to it
+git commit -m "…" -m "{{trailer}}: <id>"
+# close it
+{{command}} done <id>
+# derive, regenerate, validate
+{{command}} index && {{command}} check
 ```
 
 Write by hand only `title`, `status`, `supersedes` and `related`. The rest is derived —
@@ -26,4 +31,4 @@ Write by hand only `title`, `status`, `supersedes` and `related`. The rest is de
 `superseded-by` from the newer document, `updated` from git — because a field someone has
 to remember to update will be wrong.
 
-The method in full: `honestdocs guide`.
+The method in full: `{{command}} guide`.

package/guide/skill/SKILL.md

@@ -12,7 +12,7 @@ and the code disagree, believe the code and correct the document.
 ## When a session starts
 
 ```sh
-honestdocs brief
+{{command}} brief
 ```
 
 Work in progress with its next unticked items, what is planned, what changed lately,
@@ -21,16 +21,16 @@ the hand-over from the last session.
 
 ## Before building
 
-1. **Has this been weighed before?** `honestdocs search <words>`; with
+1. **Has this been weighed before?** `{{command}} search <words>`; with
    `--section alternatives` it shows only what was considered and rejected, with the
    reason. Superseded and abandoned documents are included on purpose. Do not propose a
    rejected option again without saying what has changed.
-2. **Which rules apply?** `honestdocs rules` lists the numbered rules in force and the
+2. **Which rules apply?** `{{command}} rules` lists the numbered rules in force and the
    tests that prove them. Go through the `before-you-build` checklist in `{{root}}/rules/`.
 3. **Open a document** for anything non-trivial:
 
    ```sh
-   honestdocs new <area> <slug> --type design --title "Token rotation"
+   {{command}} new <area> <slug> --type design --title "Token rotation"
    ```
 
    Types: `design` (how it should work), `plan` (ordered steps, checklist), `research`
@@ -46,26 +46,26 @@ the hand-over from the last session.
   {{trailer}}: 2026-11-02-token-rotation
   ```
 
-  That is how `honestdocs index` learns which files the document touched. Several ids:
+  That is how `{{command}} index` learns which files the document touched. Several ids:
   comma-separated or one line each.
 - Tick checklist items (`- [x]`) as they land. Add dated notes to the Log.
 - Never write `progress`, `files`, `superseded-by` or `updated` by hand. Write only
   `title`, `status`, `supersedes`, `related`.
 - Replacing a document: `supersedes: [<old id>]` in the **new** one, then
-  `honestdocs index` marks the old one.
+  `{{command}} index` marks the old one.
 - A rule changed: edit its rule document in place and add a Log line — never a second
   document beside it.
 
 ## Finishing
 
 ```sh
-honestdocs done <id>              # refuses while checklist items are unticked
-honestdocs done <id> --abandoned  # dropped on purpose; the reason goes in the Log
-honestdocs status <id> current    # living documents: draft | current | retired
-honestdocs index && honestdocs check
+{{command}} done <id>              # refuses while checklist items are unticked
+{{command}} done <id> --abandoned  # dropped on purpose; the reason goes in the Log
+{{command}} status <id> current    # living documents: draft | current | retired
+{{command}} index && {{command}} check
 ```
 
 `check` exits 1 on anything that makes the set lie. A change is not finished while a
 document or rule it affects still describes the old behaviour.
 
-Every query command takes `--json`. The method in full: `honestdocs guide`.
+Every query command takes `--json`. The method in full: `{{command}} guide`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "honestdocs",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Development documents that stay true — decisions, designs, plans, research, postmortems and standing rules, kept honest for people and AI agents.",
   "keywords": [
     "documentation",
@@ -36,8 +36,8 @@
   },
   "scripts": {
     "test": "node --test",
-    "prepack": "node scripts/npm-readme.mjs pack",
-    "postpack": "node scripts/npm-readme.mjs restore",
+    "prepublishOnly": "node scripts/npm-readme.mjs pack",
+    "postpublish": "node scripts/npm-readme.mjs restore",
     "assets": "node scripts/build-assets.mjs",
     "docs:index": "node bin/honestdocs.mjs index",
     "docs:check": "node bin/honestdocs.mjs check"

package/src/commands/check.mjs

@@ -37,6 +37,7 @@ function runCheck(config, { fix = false } = {}) {
   const fixed = [];
   const err = (d, msg) => errors.push({ file: d.rel, msg });
   const warnAt = (d, msg) => warnings.push({ file: d.rel, msg });
+  const cmd = config.command;
 
   const ids = new Map();
   for (const d of docs) {
@@ -47,7 +48,7 @@ function runCheck(config, { fix = false } = {}) {
   for (const d of docs) {
     const m = d.meta;
     if (!d.hasMeta) {
-      err(d, "no frontmatter — start documents with `honestdocs new`, or add the block by hand");
+      err(d, `no frontmatter — start documents with \`${cmd} new\`, or add the block by hand`);
       continue;
     }
     if (!m.id) err(d, "missing `id`");
@@ -91,7 +92,7 @@ function runCheck(config, { fix = false } = {}) {
       warnAt(d, "superseded, but nothing says by what — set `supersedes` on the newer document");
     }
     if ((m.status === "done" || m.status === "abandoned") && !m.completed && m.legacy !== true) {
-      warnAt(d, `${m.status} but \`completed\` is empty — close documents with \`honestdocs done\``);
+      warnAt(d, `${m.status} but \`completed\` is empty — close documents with \`${cmd} done\``);
     }
     if (m.status === "done") {
       const p = checklistProgress(d.body);
@@ -127,8 +128,8 @@ function runCheck(config, { fix = false } = {}) {
   for (const ch of derive(config, docs.filter((d) => d.hasMeta && d.meta.id === d.id), facts)) {
     for (const k of new Set([...Object.keys(ch.before), ...Object.keys(ch.meta)])) {
       if (JSON.stringify(ch.before[k]) === JSON.stringify(ch.meta[k])) continue;
-      const msg = `\`${k}\` is ${JSON.stringify(ch.before[k] ?? "")}, should be ${JSON.stringify(ch.meta[k])} — run \`honestdocs index\``;
-      if (k === "status") err(ch.doc, `replaced by ${ch.meta["superseded-by"]} but still says "${ch.before.status}" — run \`honestdocs index\``);
+      const msg = `\`${k}\` is ${JSON.stringify(ch.before[k] ?? "")}, should be ${JSON.stringify(ch.meta[k])} — run \`${cmd} index\``;
+      if (k === "status") err(ch.doc, `replaced by ${ch.meta["superseded-by"]} but still says "${ch.before.status}" — run \`${cmd} index\``);
       else if (k === "progress" || k === "superseded-by") err(ch.doc, msg);
       else warnAt(ch.doc, msg);
     }
@@ -138,9 +139,9 @@ function runCheck(config, { fix = false } = {}) {
   // so a commit can never make it stale on its own.
   const indexFile = join(config.docsDir, "INDEX.md");
   const expected = renderIndex(config, docs.filter((d) => d.hasMeta));
-  if (!existsSync(indexFile)) errors.push({ file: "INDEX.md", msg: "missing — run `honestdocs index`" });
+  if (!existsSync(indexFile)) errors.push({ file: "INDEX.md", msg: `missing — run \`${cmd} index\`` });
   else if (readFileSync(indexFile, "utf8") !== expected) {
-    errors.push({ file: "INDEX.md", msg: "stale: frontmatter changed since it was generated — run `honestdocs index`" });
+    errors.push({ file: "INDEX.md", msg: `stale: frontmatter changed since it was generated — run \`${cmd} index\`` });
   }
 
   return { documents: docs.length, git: facts.available ? "ok" : facts.reason, errors, warnings, fixed };

package/src/commands/done.mjs

@@ -29,7 +29,7 @@ export function run(argv) {
 
   if (lifecycleOf(config, doc.meta.type) !== "work") {
     die(`${id} is a ${doc.meta.type} — a living document is never finished. ` +
-      "Keep it current, or retire it: `honestdocs status " + id + " retired`");
+      `Keep it current, or retire it: \`${config.command} status ${id} retired\``);
   }
 
   const status = args.abandoned ? "abandoned" : "done";

package/src/commands/guide.mjs

@@ -1,5 +1,5 @@
 import { UsageError, parseArgs } from "../cli.mjs";
-import { DEFAULT_ROOT, findConfig, loadConfig } from "../config.mjs";
+import { DEFAULT_ROOT, findConfig, loadConfig, runnerCommand } from "../config.mjs";
 import { fill, packageFile } from "../templates.mjs";
 
 export const summary = "print the method, the agent instructions or the skill";
@@ -24,6 +24,10 @@ export function run(argv) {
   const topic = args._[0] ?? "method";
   if (!TOPICS[topic]) throw new UsageError(`unknown topic "${topic}" — expected: ${Object.keys(TOPICS).join(", ")}`);
   const config = findConfig() ? loadConfig() : null;
-  const values = { root: config?.root ?? DEFAULT_ROOT, trailer: config?.trailer ?? "Doc" };
+  const values = {
+    root: config?.root ?? DEFAULT_ROOT,
+    trailer: config?.trailer ?? "Doc",
+    command: config?.command ?? runnerCommand(),
+  };
   console.log(fill(packageFile("guide", ...TOPICS[topic]), values).trimEnd());
 }

package/src/commands/init.mjs

@@ -1,7 +1,7 @@
 import { existsSync, mkdirSync, readdirSync, readFileSync, writeFileSync } from "node:fs";
 import { dirname, join, relative, resolve } from "node:path";
 import { c, die, ok, parseArgs, say } from "../cli.mjs";
-import { CONFIG_FILE, CONFIG_IN_ROOT, DEFAULT_AREAS, DEFAULT_ROOT, findConfig, loadConfig } from "../config.mjs";
+import { CONFIG_FILE, CONFIG_IN_ROOT, DEFAULT_AREAS, DEFAULT_ROOT, findConfig, loadConfig, runnerCommand } from "../config.mjs";
 import { today } from "../docs.mjs";
 import { stringify } from "../frontmatter.mjs";
 import { fill, packageFile } from "../templates.mjs";
@@ -68,8 +68,12 @@ function upsertBlock(file, block) {
   return "appended";
 }
 
-function installAgentBits(base, args, root, trailer) {
-  const values = { root, trailer };
+/** What the guide texts are filled with: where the documents live, and how to run the tool. */
+const guideValues = (config) => ({ root: config.root, trailer: config.trailer, command: config.command });
+
+function installAgentBits(config, args) {
+  const base = config.base;
+  const values = guideValues(config);
   if (args.agents || args["agents-file"]) {
     const file = resolve(base, args["agents-file"] ?? "AGENTS.md");
     const how = upsertBlock(file, fill(packageFile("guide", "agents-snippet.md"), values));
@@ -96,7 +100,7 @@ export function run(argv) {
     if (!args.agents && !args["agents-file"] && !args.skill) {
       die(`already set up: ${existing.file} — re-run with --agents or --skill to refresh those`);
     }
-    installAgentBits(config.base, args, config.root, config.trailer);
+    installAgentBits(config, args);
     return;
   }
 
@@ -117,6 +121,7 @@ export function run(argv) {
     title: args.title ?? "Development documents",
     areas,
     trailer: "Doc",
+    command: runnerCommand(),
     codeRepos: args["code-repo"].length ? args["code-repo"] : ["."],
   };
   const configPath = root === DEFAULT_ROOT ? CONFIG_IN_ROOT : CONFIG_FILE;
@@ -129,7 +134,7 @@ export function run(argv) {
 
   const readme = join(config.docsDir, "README.md");
   if (!existsSync(readme)) {
-    writeFileSync(readme, fill(packageFile("guide", "docs-readme.md"), { root, trailer: config.trailer }));
+    writeFileSync(readme, fill(packageFile("guide", "docs-readme.md"), guideValues(config)));
     ok(`${root}/README.md`);
   }
 
@@ -150,17 +155,18 @@ export function run(argv) {
     related: [],
     files: [],
   };
-  writeFileSync(rulesFile, stringify(meta) + fill(packageFile("guide", "before-you-build.md"), { root, trailer: config.trailer }));
+  writeFileSync(rulesFile, stringify(meta) + fill(packageFile("guide", "before-you-build.md"), guideValues(config)));
   ok(`${root}/rules/${id}.md`);
 
-  installAgentBits(config.base, args, root, config.trailer);
+  installAgentBits(config, args);
   report(config, runIndex(config), false);
 
   say("");
   const area = Object.keys(config.areas).find((a) => a !== "rules") ?? "rules";
+  const cmd = config.command;
   say("Next:");
-  say(c.dim(`  start a document     honestdocs new ${area} my-first-design --title "…"`));
+  say(c.dim(`  start a document     ${cmd} new ${area} my-first-design --title "…"`));
   say(c.dim(`  link work to it      git commit -m "…" -m "${config.trailer}: <id>"`));
-  say(c.dim("  keep it honest       honestdocs index && honestdocs check"));
-  if (!args.agents && !args["agents-file"]) say(c.dim("  teach your agents    honestdocs init --agents"));
+  say(c.dim(`  keep it honest       ${cmd} index && ${cmd} check`));
+  if (!args.agents && !args["agents-file"]) say(c.dim(`  teach your agents    ${cmd} init --agents`));
 }

package/src/commands/new.mjs

@@ -2,8 +2,9 @@ import { existsSync, mkdirSync, writeFileSync } from "node:fs";
 import { join, relative } from "node:path";
 import { UsageError, c, die, emitJson, ok, parseArgs, say } from "../cli.mjs";
 import { loadConfig, statusesFor } from "../config.mjs";
-import { loadDocs, slugify, today } from "../docs.mjs";
+import { checklistProgress, loadDocs, slugify, today } from "../docs.mjs";
 import { stringify } from "../frontmatter.mjs";
+import { renderIndex } from "../render.mjs";
 import { fill, templateFor } from "../templates.mjs";
 
 export const summary = "start a document";
@@ -70,7 +71,9 @@ export function run(argv) {
     related: args.related,
     files: [],
   };
-  const content = stringify(meta) + fill(templateFor(config, type), { title: args.title, id, date: today() });
+  const body = fill(templateFor(config, type), { title: args.title, id, date: today() });
+  meta.progress = checklistProgress(body);
+  const content = stringify(meta) + body;
   const file = join(config.docsDir, area, `${id}.md`);
   const shown = relative(config.base, file).split("\\").join("/");
 
@@ -82,10 +85,13 @@ export function run(argv) {
   if (existsSync(file)) die(`${shown} already exists`);
   mkdirSync(join(config.docsDir, area), { recursive: true });
   writeFileSync(file, content);
+  // A new document has no commits yet, so nothing git knows can change: rendering the
+  // index is enough for `check` to pass, without the git pass a full `index` makes.
+  writeFileSync(join(config.docsDir, "INDEX.md"), renderIndex(config, loadDocs(config).filter((d) => d.hasMeta)));
 
   if (args.json) return emitJson({ id, path: shown, type, status });
   ok(c.dim(`${type} · ${area} · ${status}`));
   say(c.dim(`  Put "${config.trailer}: ${id}" in the commits that do this work —`));
-  say(c.dim("  that is how `honestdocs index` learns which files it touched."));
+  say(c.dim(`  that is how \`${config.command} index\` learns which files it touched.`));
   console.log(shown);
 }

package/src/commands/status.mjs

@@ -28,9 +28,9 @@ export function run(argv) {
   const allowed = statusesFor(config, doc.meta.type);
   if (!allowed) die(`${doc.rel} has an unknown type "${doc.meta.type}"`);
   if (status === "superseded") {
-    die("set `supersedes: [" + id + "]` on the document that replaces it, then run `honestdocs index`");
+    die(`set \`supersedes: [${id}]\` on the document that replaces it, then run \`${config.command} index\``);
   }
-  if (status === "done" || status === "abandoned") die(`use \`honestdocs done ${id}${status === "abandoned" ? " --abandoned" : ""}\` — it checks the checklist first`);
+  if (status === "done" || status === "abandoned") die(`use \`${config.command} done ${id}${status === "abandoned" ? " --abandoned" : ""}\` — it checks the checklist first`);
   if (!allowed[status]) {
     die(`"${status}" is not a status for a ${doc.meta.type} (${lifecycleOf(config, doc.meta.type)}) — expected one of: ${Object.keys(allowed).filter((s) => s !== "superseded").join(", ")}`);
   }

package/src/config.mjs

@@ -1,4 +1,4 @@
-// Finding and reading honestdocs.config.json.
+// Finding and reading the config: .honestdocs/config.json, or honestdocs.config.json.
 //
 // The config is found by walking up from the working directory, the way git finds .git,
 // so every command works from anywhere inside the project. Everything a project may want
@@ -52,6 +52,22 @@ const DEFAULT_TYPES = {
   rule: { lifecycle: "living", description: "Numbered rules every change must keep, each naming its test where it can" },
 };
 
+/**
+ * How a project runs honestdocs, for every command the tool prints or writes into
+ * AGENTS.md. A bare `honestdocs` exists only after a global install, on one machine; a
+ * project set up with `npx honestdocs init` has no such command, and an agent told to run
+ * `honestdocs brief` fails on its first step. So `init` records the package runner that
+ * started it — never the bare name — and a config without one means npx.
+ */
+export const DEFAULT_COMMAND = "npx honestdocs";
+
+export function runnerCommand(env = process.env) {
+  const agent = env.npm_config_user_agent ?? "";
+  if (agent.startsWith("bun/")) return "bunx honestdocs";
+  if (agent.startsWith("pnpm/")) return "pnpm dlx honestdocs";
+  return DEFAULT_COMMAND;
+}
+
 export const DEFAULT_AREAS = {
   general: "Anything that does not belong to a narrower area yet",
   rules: "Standing rules every change must keep — read before building, updated in place",
@@ -82,7 +98,7 @@ export function findConfig(start = process.cwd()) {
  */
 export function loadConfig(start = process.cwd()) {
   const found = findConfig(start);
-  if (!found) throw new Failure(`no ${CONFIG_IN_ROOT} here or above — run \`honestdocs init\` first`);
+  if (!found) throw new Failure(`no ${CONFIG_IN_ROOT} here or above — run \`${runnerCommand()} init\` first`);
   let raw;
   try {
     raw = JSON.parse(readFileSync(found.file, "utf8"));
@@ -133,6 +149,7 @@ function normalise(raw, base, file = join(base, CONFIG_FILE)) {
     areas,
     types,
     trailer,
+    command: typeof raw.command === "string" && raw.command.trim() ? raw.command.trim() : DEFAULT_COMMAND,
     codeRepos,
     templatesDir: raw.templates ? resolve(base, raw.templates) : null,
     recent: Number.isInteger(raw.recent) && raw.recent > 0 ? raw.recent : 25,

package/src/render.mjs

@@ -33,7 +33,7 @@ export function renderIndex(config, docs) {
   const lines = [
     `# ${config.title}`,
     "",
-    "> Generated by `honestdocs index`. Do not edit — change the document's own frontmatter",
+    `> Generated by \`${config.command} index\`. Do not edit — change the document's own frontmatter`,
     "> and run it again.",
     ">",
     "> **The code is the truth.** A document records what was decided at the time. Where the",