@clidoc/cli 0.1.0 → 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+## [@clidoc/cli-v1.0.0](https://github.com/bhouston/clidoc/compare/@clidoc/cli-v0.1.0...@clidoc/cli-v1.0.0) (2026-09-22)
+
+### ⚠ BREAKING CHANGES
+
+* @clidoc/adapter-yargs is now @clidoc/yargs,
+@clidoc/adapter-commander is now @clidoc/commander, and @clidoc/adapter-oclif
+is now @clidoc/oclif. Update imports and dependencies to the new names.
+* **cli:** the `clidoc generate` command is removed. Use your CLI's own
+`docgen`/`__opencli` command, or the framework adapters' `fromYargs`,
+`fromCommander`, and `fromOclif` functions in code instead.
+
+### Code Refactoring
+
+* **cli:** remove generate command ([2a821e7](https://github.com/bhouston/clidoc/commit/2a821e7ac1593e5bc1a87edf7c7373ade56039f3)), closes [#127](https://github.com/bhouston/clidoc/issues/127)
+* rename adapter packages to @clidoc/yargs, @clidoc/commander, @clidoc/oclif ([0e53199](https://github.com/bhouston/clidoc/commit/0e53199031de597485399079076b4050e7f5fa6a)), closes [#129](https://github.com/bhouston/clidoc/issues/129)

package/README.md

@@ -20,21 +20,14 @@ clidoc markdown cli.json --output reference.md
 ```
 
 `mycli __opencli` is the hidden, machine-facing discovery subcommand, matching
-upstream OpenCLI's Go adapters, including its `-o`/`--out <file>` flag
+upstream OpenCLI's Go libraries, including its `-o`/`--out <file>` flag
 (`mycli __opencli --out cli.json`); omitted, it writes to stdout like
-`clidoc docgen`/`clidoc generate`/`clidoc markdown` do when their own
+`clidoc docgen`/`clidoc markdown` do when their own
 `--output` is omitted. clidoc dogfoods this exact workflow on itself:
-`clidoc docgen` and `clidoc __opencli` both describe the `clidoc` binary. As a
-secondary option, trusted command definitions can be imported with
-`clidoc generate ./definition.mjs --adapter yargs --output cli.json`. Invalid
+`clidoc docgen` and `clidoc __opencli` both describe the `clidoc` binary. Invalid
 input or command usage exits with status 1. `--help` describes command
 arguments, and `--version` prints the installed package version.
 
-The generation module must export `info` (`title`, `binary`, `version`) and a
-default value: Yargs command modules, a Commander `Command`, or an oclif manifest.
-Only import trusted modules: their top-level code and supported Yargs builder
-callbacks execute during generation. Command handlers are never invoked.
-
 Commands are separate files registered through `yargs-file-commands`, matching
 the `hdrify` approach. `cliDocument()` derives this tool's OpenCLI document from
 those same definitions. `runCli(argv)` supports embedding without exiting the
@@ -58,7 +51,7 @@ For Bash, activate with `source <(clidoc completion bash)`. For Zsh, run
 `source <(clidoc completion zsh)` after `autoload -Uz compinit; compinit`.
 Use `--binary name` to register an alternative executable name. Generated scripts
 need neither Node nor clidoc at completion time. Regenerate them after CLI changes.
-See the [completion guide](https://clidoc.dev/docs/guides/completion) for
+See the [completion guide](https://clidoc.dev/docs/completion) for
 persistent installation, supported syntax, and limitations.
 
 ## MCP tools and stdio server
@@ -71,7 +64,7 @@ clidoc mcp cli.json --serve --executable /absolute/path/to/mycli
 Exporting does not execute the CLI. Serving requires an explicit trusted
 executable and validates every tool invocation. The bridge uses conventional
 long options and `--` before positional arguments; see the
-[MCP guide](../website/docs/guides/mcp.md) for the serialization contract,
+[MCP guide](../website/docs/mcp.md) for the serialization contract,
 client configuration, limits, and supported spec features.
 
 Library users can import `compileMcpTools`, `createMcpServer`, and `serveMcp`

package/dist/definition.d.ts

@@ -14,12 +14,6 @@ export declare const commands: (import("yargs-file-commands").DefineCommandResul
     input: string;
 } & {
     output: string | undefined;
-}> | import("yargs-file-commands").DefineCommandResult<{}, {
-    module: string;
-} & {
-    adapter: "commander" | "oclif" | "yargs";
-} & {
-    output: string | undefined;
 }> | import("yargs-file-commands").DefineCommandResult<{}, {
     shell: "bash" | "fish" | "zsh";
 } & {

package/dist/definition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"definition.d.ts","sourceRoot":"","sources":["../src/definition.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,IAAI;IACf,KAAK;IACL,MAAM;IACN,OAAO;IACP,OAAO;CACR,CAAC;AACF,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAA0D,CAAC;AAChF,0EAA0E;AAC1E,wBAAgB,WAAW,2CAS1B"}
+{"version":3,"file":"definition.d.ts","sourceRoot":"","sources":["../src/definition.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,IAAI;IACf,KAAK;IACL,MAAM;IACN,OAAO;IACP,OAAO;CACR,CAAC;AACF,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAAgD,CAAC;AACtE,0EAA0E;AAC1E,wBAAgB,WAAW,2CAS1B"}

package/dist/definition.js

@@ -1,8 +1,7 @@
 import { createRequire } from 'node:module';
-import { fromYargs } from '@clidoc/adapter-yargs';
+import { fromYargs } from '@clidoc/yargs';
 import { command as completion } from './commands/completion.js';
 import { command as docgen } from './commands/docgen.js';
-import { command as generate } from './commands/generate.js';
 import { command as mcp } from './commands/mcp.js';
 import { command as markdown } from './commands/markdown.js';
 import { command as validate } from './commands/validate.js';
@@ -13,7 +12,7 @@ export const info = {
     version: packageJson.version,
     summary: 'Generate, validate, and publish CLI documentation through OpenCLI.',
 };
-export const commands = [generate, markdown, validate, docgen, completion, mcp];
+export const commands = [markdown, validate, docgen, completion, mcp];
 /** Documentation and runtime share the exact same command definitions. */
 export function cliDocument() {
     const document = fromYargs(commands, info);

package/dist/definition.js.map

@@ -1 +1 @@
-{"version":3,"file":"definition.js","sourceRoot":"","sources":["../src/definition.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAE7D,MAAM,WAAW,GAAG,aAAa,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,iBAAiB,CAAwB,CAAC;AAE7F,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,WAAW,CAAC,OAAO;IAC5B,OAAO,EAAE,oEAAoE;CAC9E,CAAC;AACF,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC;AAChF,0EAA0E;AAC1E,MAAM,UAAU,WAAW;IACzB,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC3C,QAAQ,CAAC,MAAM,GAAG;QAChB,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE;YACvD,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,qBAAqB,EAAE;SACrE;KACF,CAAC;IACF,OAAO,QAAQ,CAAC;AAClB,CAAC"}
+{"version":3,"file":"definition.js","sourceRoot":"","sources":["../src/definition.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAE7D,MAAM,WAAW,GAAG,aAAa,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,iBAAiB,CAAwB,CAAC;AAE7F,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,WAAW,CAAC,OAAO;IAC5B,OAAO,EAAE,oEAAoE;CAC9E,CAAC;AACF,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC;AACtE,0EAA0E;AAC1E,MAAM,UAAU,WAAW;IACzB,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC3C,QAAQ,CAAC,MAAM,GAAG;QAChB,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE;YACvD,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,qBAAqB,EAAE;SACrE;KACF,CAAC;IACF,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clidoc/cli",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "Generate and validate OpenCLI documentation",
   "keywords": [
     "cli",
@@ -54,10 +54,8 @@
     "tsc": "tsc --noEmit"
   },
   "dependencies": {
-    "@clidoc/adapter-commander": "^0.1.0",
-    "@clidoc/adapter-oclif": "^0.1.0",
-    "@clidoc/adapter-yargs": "^0.1.0",
-    "@clidoc/core": "^0.1.0",
+    "@clidoc/core": "^1.0.0",
+    "@clidoc/yargs": "^0.1.0",
     "@modelcontextprotocol/sdk": "^1.30.0",
     "ajv": "^8.20.0",
     "yargs": "^18.1.0",

package/src/definition.ts

@@ -1,8 +1,7 @@
 import { createRequire } from 'node:module';
-import { fromYargs } from '@clidoc/adapter-yargs';
+import { fromYargs } from '@clidoc/yargs';
 import { command as completion } from './commands/completion.js';
 import { command as docgen } from './commands/docgen.js';
-import { command as generate } from './commands/generate.js';
 import { command as mcp } from './commands/mcp.js';
 import { command as markdown } from './commands/markdown.js';
 import { command as validate } from './commands/validate.js';
@@ -15,7 +14,7 @@ export const info = {
   version: packageJson.version,
   summary: 'Generate, validate, and publish CLI documentation through OpenCLI.',
 };
-export const commands = [generate, markdown, validate, docgen, completion, mcp];
+export const commands = [markdown, validate, docgen, completion, mcp];
 /** Documentation and runtime share the exact same command definitions. */
 export function cliDocument() {
   const document = fromYargs(commands, info);

package/dist/commands/generate.d.ts

@@ -1,8 +0,0 @@
-export declare const command: import("yargs-file-commands").DefineCommandResult<{}, {
-    module: string;
-} & {
-    adapter: "commander" | "oclif" | "yargs";
-} & {
-    output: string | undefined;
-}>;
-//# sourceMappingURL=generate.d.ts.map

package/dist/commands/generate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/commands/generate.ts"],"names":[],"mappings":"AASA,eAAO,MAAM,OAAO;;;;;;EAgClB,CAAC"}

package/dist/commands/generate.js

@@ -1,40 +0,0 @@
-import { resolve } from 'node:path';
-import { pathToFileURL } from 'node:url';
-import { parse } from '@clidoc/core';
-import { fromYargs } from '@clidoc/adapter-yargs';
-import { fromCommander } from '@clidoc/adapter-commander';
-import { fromOclif } from '@clidoc/adapter-oclif';
-import { defineCommand } from 'yargs-file-commands';
-import { output } from '../io.js';
-export const command = defineCommand({
-    command: 'generate <module>',
-    describe: 'Import a trusted framework definition module and generate OpenCLI JSON',
-    builder: (yargs) => yargs
-        .positional('module', {
-        type: 'string',
-        demandOption: true,
-        describe: 'Trusted JS module exporting default metadata and info',
-    })
-        .option('adapter', {
-        type: 'string',
-        choices: ['yargs', 'commander', 'oclif'],
-        demandOption: true,
-        describe: 'Framework adapter',
-    })
-        .option('output', { type: 'string', alias: 'o', describe: 'Output JSON file; defaults to stdout' }),
-    handler: async (argv) => {
-        // Importing code is intentional: this command accepts trusted local modules only.
-        const source = await import(pathToFileURL(resolve(argv.module)).href);
-        if (!source.default || !source.info)
-            throw new Error('Module must export default framework metadata and named info');
-        const document = argv.adapter === 'yargs'
-            ? fromYargs(source.default, source.info)
-            : argv.adapter === 'commander'
-                ? fromCommander(source.default, source.info)
-                : fromOclif(source.default, source.info);
-        const json = JSON.stringify(document, null, 2) + '\n';
-        parse(json);
-        await output(json, argv.output);
-    },
-});
-//# sourceMappingURL=generate.js.map

package/dist/commands/generate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/commands/generate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,MAAM,CAAC,MAAM,OAAO,GAAG,aAAa,CAAC;IACnC,OAAO,EAAE,mBAAmB;IAC5B,QAAQ,EAAE,wEAAwE;IAClF,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CACjB,KAAK;SACF,UAAU,CAAC,QAAQ,EAAE;QACpB,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,uDAAuD;KAClE,CAAC;SACD,MAAM,CAAC,SAAS,EAAE;QACjB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAU;QACjD,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,mBAAmB;KAC9B,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,sCAAsC,EAAE,CAAC;IACvG,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QACtB,kFAAkF;QAClF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACtE,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI;YACjC,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;QAClF,MAAM,QAAQ,GACZ,IAAI,CAAC,OAAO,KAAK,OAAO;YACtB,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC;YACxC,CAAC,CAAC,IAAI,CAAC,OAAO,KAAK,WAAW;gBAC5B,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC;gBAC5C,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;QACtD,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,MAAM,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;CACF,CAAC,CAAC"}

package/src/commands/generate.ts

@@ -1,42 +0,0 @@
-import { resolve } from 'node:path';
-import { pathToFileURL } from 'node:url';
-import { parse } from '@clidoc/core';
-import { fromYargs } from '@clidoc/adapter-yargs';
-import { fromCommander } from '@clidoc/adapter-commander';
-import { fromOclif } from '@clidoc/adapter-oclif';
-import { defineCommand } from 'yargs-file-commands';
-import { output } from '../io.js';
-
-export const command = defineCommand({
-  command: 'generate <module>',
-  describe: 'Import a trusted framework definition module and generate OpenCLI JSON',
-  builder: (yargs) =>
-    yargs
-      .positional('module', {
-        type: 'string',
-        demandOption: true,
-        describe: 'Trusted JS module exporting default metadata and info',
-      })
-      .option('adapter', {
-        type: 'string',
-        choices: ['yargs', 'commander', 'oclif'] as const,
-        demandOption: true,
-        describe: 'Framework adapter',
-      })
-      .option('output', { type: 'string', alias: 'o', describe: 'Output JSON file; defaults to stdout' }),
-  handler: async (argv) => {
-    // Importing code is intentional: this command accepts trusted local modules only.
-    const source = await import(pathToFileURL(resolve(argv.module)).href);
-    if (!source.default || !source.info)
-      throw new Error('Module must export default framework metadata and named info');
-    const document =
-      argv.adapter === 'yargs'
-        ? fromYargs(source.default, source.info)
-        : argv.adapter === 'commander'
-          ? fromCommander(source.default, source.info)
-          : fromOclif(source.default, source.info);
-    const json = JSON.stringify(document, null, 2) + '\n';
-    parse(json);
-    await output(json, argv.output);
-  },
-});