cli-forge 0.2.0 → 0.4.0

package/bin/cli.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+declare const mycli: import("../src").CLI<{
+    unmatched: string[];
+    '--'?: string[];
+}>;
+export default mycli;

package/bin/cli.js

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const src_1 = require("../src");
+const generate_documentation_1 = require("./commands/generate-documentation");
+const init_1 = require("./commands/init");
+const mycli = (0, src_1.cli)('cli-forge').commands(generate_documentation_1.generateDocumentationCommand, init_1.initCommand);
+exports.default = mycli;
+mycli.forge();
+//# sourceMappingURL=cli.js.map

package/bin/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../../packages/cli-forge/bin/cli.ts"],"names":[],"mappings":";;;AAEA,gCAA6B;AAC7B,8EAAiF;AACjF,0CAA8C;AAE9C,MAAM,KAAK,GAAG,IAAA,SAAG,EAAC,WAAW,CAAC,CAAC,QAAQ,CACrC,qDAA4B,EAC5B,kBAAW,CACZ,CAAC;AAEF,kBAAe,KAAK,CAAC;AAErB,KAAK,CAAC,KAAK,EAAE,CAAC"}

package/bin/commands/generate-documentation.d.ts

@@ -0,0 +1,12 @@
+import type { ParsedArgs } from '@cli-forge/parser';
+import { CLI } from '../../src/lib/cli-forge';
+export declare function withGenerateDocumentationArgs<T extends ParsedArgs>(cmd: CLI<T>): CLI<T & {
+    cli: string;
+} & {
+    output: string;
+} & {
+    format: string;
+} & {
+    export: string;
+}>;
+export declare const generateDocumentationCommand: CLI;

package/bin/commands/generate-documentation.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateDocumentationCommand = void 0;
+exports.withGenerateDocumentationArgs = withGenerateDocumentationArgs;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const src_1 = require("../../src");
+const documentation_1 = require("../../src/lib/documentation");
+const cli_forge_1 = require("../../src/lib/cli-forge");
+const fs_1 = require("../utils/fs");
+function withGenerateDocumentationArgs(cmd) {
+    return cmd
+        .positional('cli', {
+        type: 'string',
+        description: 'Path to the cli that docs should be generated for.',
+        required: true,
+    })
+        .option('output', {
+        alias: ['o'],
+        type: 'string',
+        description: 'Where should the documentation be output?',
+        default: 'docs',
+    })
+        .option('format', {
+        type: 'string',
+        description: 'What format should the documentation be output in? (json, md)',
+        default: 'md',
+    })
+        .option('export', {
+        type: 'string',
+        description: 'The name of the export that contains the CLI instance. By default, docs will be generated for the default export.',
+    });
+}
+exports.generateDocumentationCommand = (0, src_1.default)('generate-documentation', {
+    description: 'Generate documentation for the given CLI',
+    builder: (b) => withGenerateDocumentationArgs(b),
+    handler: async (args) => {
+        if (args.cli.startsWith('./')) {
+            args.cli = (0, node_path_1.join)(process.cwd(), args.cli);
+        }
+        const cliModule = await Promise.resolve(`${args.cli}`).then(s => require(s));
+        const cli = cliModule[args.export || 'default'] ?? cliModule;
+        if (!(cli instanceof cli_forge_1.InternalCLI)) {
+            throw new Error(`${args.cli}${args.export ? '#' + args.export : ''} is not a CLI.`);
+        }
+        const documentation = (0, documentation_1.generateDocumentation)(cli);
+        if (args.format === 'md') {
+            await generateMarkdownDocumentation(documentation, args);
+        }
+        else if (args.format === 'json') {
+            const outfile = args.output.endsWith('json')
+                ? args.output
+                : (0, node_path_1.join)(args.output, cli.name + '.json');
+            const outdir = (0, node_path_1.dirname)(outfile);
+            (0, fs_1.ensureDirSync)(outdir);
+            (0, node_fs_1.writeFileSync)(outfile, JSON.stringify(documentation, null, 2));
+        }
+    },
+});
+async function generateMarkdownDocumentation(docs, args) {
+    const md = await importMarkdownFactory();
+    await generateMarkdownForSingleCommand(docs, (0, node_path_1.join)(args.output, docs.name), md);
+}
+async function generateMarkdownForSingleCommand(docs, out, md) {
+    const subcommands = docs.subcommands;
+    const outdir = subcommands.length ? out : (0, node_path_1.dirname)(out);
+    const outname = subcommands.length ? 'index' : docs.name;
+    (0, fs_1.ensureDirSync)(outdir);
+    (0, node_fs_1.writeFileSync)((0, node_path_1.join)(outdir, outname + '.md'), md.h1(docs.name, ...[
+        docs.description,
+        getPositionalArgsFragment(docs.positionals, md),
+        getFlagArgsFragment(docs.options, md),
+        getSubcommandsFragment(docs.subcommands, md),
+    ].filter(isTruthy)));
+    for (const subcommand of docs.subcommands) {
+        await generateMarkdownForSingleCommand(subcommand, (0, node_path_1.join)(outdir, subcommand.name), md);
+    }
+}
+function formatOption(option, md) {
+    return md.h3(option.key, ...[
+        md.bold('Type:') +
+            ' ' +
+            (option.type === 'array'
+                ? `${option.items}[]`
+                : option.type),
+        option.description,
+        option.default ? md.bold('Default:') + ' ' + option.default : undefined,
+        option.required ? md.bold('Required') : undefined,
+        option.alias?.length
+            ? md.h4('Aliases', md.ul(...option.alias))
+            : undefined,
+    ].filter(isTruthy));
+}
+function getPositionalArgsFragment(positionals, md) {
+    if (positionals?.length === 0) {
+        return undefined;
+    }
+    return md.h2('Positional Arguments', ...positionals.map((positional) => formatOption(positional, md)));
+}
+function getFlagArgsFragment(options, md) {
+    if (Object.keys(options).length === 0) {
+        return undefined;
+    }
+    return md.h2('Flags', ...Object.values(options).map((option) => formatOption(option, md)));
+}
+function getSubcommandsFragment(subcommands, md) {
+    if (subcommands.length === 0) {
+        return undefined;
+    }
+    return md.h2('Subcommands', ...subcommands.map((subcommand) => md.link(`./${subcommand.name}`, subcommand.name)));
+}
+function isTruthy(value) {
+    return !!value;
+}
+async function importMarkdownFactory() {
+    try {
+        return await Promise.resolve().then(() => require('markdown-factory'));
+    }
+    catch {
+        throw new Error('Could not find markdown-factory. Please install it to generate markdown documentation.');
+    }
+}
+//# sourceMappingURL=generate-documentation.js.map

package/bin/commands/generate-documentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-documentation.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/bin/commands/generate-documentation.ts"],"names":[],"mappings":";;;AAsBA,sEA0BC;AA9CD,qCAAwC;AACxC,yCAA0C;AAE1C,mCAA4B;AAC5B,+DAGqC;AACrC,uDAA2D;AAC3D,oCAA4C;AAW5C,SAAgB,6BAA6B,CAC3C,GAAW;IAEX,OAAO,GAAG;SACP,UAAU,CAAC,KAAK,EAAE;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oDAAoD;QACjE,QAAQ,EAAE,IAAI;KACf,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,KAAK,EAAE,CAAC,GAAG,CAAC;QACZ,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,2CAA2C;QACxD,OAAO,EAAE,MAAM;KAChB,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,+DAA+D;QACjE,OAAO,EAAE,IAAI;KACd,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,mHAAmH;KACtH,CAAC,CAAC;AACP,CAAC;AAEY,QAAA,4BAA4B,GAAQ,IAAA,aAAG,EAAC,wBAAwB,EAAE;IAC7E,WAAW,EAAE,0CAA0C;IACvD,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,6BAA6B,CAAC,CAAC,CAAC;IAChD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QACtB,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,GAAG,GAAG,IAAA,gBAAI,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3C,CAAC;QACD,MAAM,SAAS,GAAG,yBAAa,IAAI,CAAC,GAAG,yBAAC,CAAC;QACzC,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,IAAI,SAAS,CAAC,IAAI,SAAS,CAAC;QAC7D,IAAI,CAAC,CAAC,GAAG,YAAY,uBAAW,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,gBAAgB,CACnE,CAAC;QACJ,CAAC;QACD,MAAM,aAAa,GAAG,IAAA,qCAAqB,EAAC,GAAG,CAAC,CAAC;QACjD,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YACzB,MAAM,6BAA6B,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QAC3D,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAClC,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;gBAC1C,CAAC,CAAC,IAAI,CAAC,MAAM;gBACb,CAAC,CAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,GAAG,OAAO,CAAC,CAAC;YAC1C,MAAM,MAAM,GAAG,IAAA,mBAAO,EAAC,OAAO,CAAC,CAAC;YAChC,IAAA,kBAAa,EAAC,MAAM,CAAC,CAAC;YACtB,IAAA,uBAAa,EAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;CACF,CAAC,CAAC;AAEH,KAAK,UAAU,6BAA6B,CAC1C,IAAmB,EACnB,IAAsB;IAEtB,MAAM,EAAE,GAAG,MAAM,qBAAqB,EAAE,CAAC;IACzC,MAAM,gCAAgC,CACpC,IAAI,EACJ,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,EAC5B,EAAE,CACH,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,gCAAgC,CAC7C,IAAmB,EACnB,GAAW,EACX,EAAa;IAEb,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;IACrC,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAA,mBAAO,EAAC,GAAG,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;IAEzD,IAAA,kBAAa,EAAC,MAAM,CAAC,CAAC;IAEtB,IAAA,uBAAa,EACX,IAAA,gBAAI,EAAC,MAAM,EAAE,OAAO,GAAG,KAAK,CAAC,EAC7B,EAAE,CAAC,EAAE,CACH,IAAI,CAAC,IAAI,EACT,GAAG;QACD,IAAI,CAAC,WAAW;QAChB,yBAAyB,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QAC/C,mBAAmB,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;QACrC,sBAAsB,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;KAC7C,CAAC,MAAM,CAAC,QAAQ,CAAC,CACnB,CACF,CAAC;IACF,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QAC1C,MAAM,gCAAgC,CACpC,UAAU,EACV,IAAA,gBAAI,EAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,EAC7B,EAAE,CACH,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,MAAwC,EAAE,EAAa;IAC3E,OAAO,EAAE,CAAC,EAAE,CACV,MAAM,CAAC,GAAG,EACV,GAAG;QACD,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;YACd,GAAG;YACH,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO;gBACtB,CAAC,CAAC,GAAI,MAA4B,CAAC,KAAK,IAAI;gBAC5C,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;QAClB,MAAM,CAAC,WAAW;QAClB,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;QACvE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;QACjD,MAAM,CAAC,KAAK,EAAE,MAAM;YAClB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC,CAAC,SAAS;KACd,CAAC,MAAM,CAAC,QAAQ,CAAC,CACnB,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB,CAChC,WAAyC,EACzC,EAAa;IAEb,IAAI,WAAW,EAAE,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,CAAC,EAAE,CACV,sBAAsB,EACtB,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CACjE,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,OAAiC,EAAE,EAAa;IAC3E,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,CAAC,EAAE,CACV,OAAO,EACP,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CACpE,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB,CAC7B,WAAyC,EACzC,EAAa;IAEb,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,CAAC,EAAE,CACV,aAAa,EACb,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAChC,EAAE,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,IAAI,EAAE,EAAE,UAAU,CAAC,IAAI,CAAC,CACjD,CACF,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAI,KAA2B;IAC9C,OAAO,CAAC,CAAC,KAAK,CAAC;AACjB,CAAC;AAED,KAAK,UAAU,qBAAqB;IAClC,IAAI,CAAC;QACH,OAAO,2CAAa,kBAAkB,EAAC,CAAC;IAC1C,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CACb,wFAAwF,CACzF,CAAC;IACJ,CAAC;AACH,CAAC"}

package/bin/commands/init.d.ts

@@ -0,0 +1,19 @@
+import type { ParsedArgs } from '@cli-forge/parser';
+import { CLI } from '../../src';
+export declare function withInitArgs<T extends ParsedArgs>(cmd: CLI<T>): CLI<T & {
+    cliName: string;
+} & {
+    output: string;
+} & {
+    format: string;
+}>;
+export declare const initCommand: CLI<{
+    unmatched: string[];
+    '--'?: string[];
+} & {
+    cliName: string;
+} & {
+    output: string;
+} & {
+    format: string;
+}>;

package/bin/commands/init.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initCommand = void 0;
+exports.withInitArgs = withInitArgs;
+const node_child_process_1 = require("node:child_process");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const package_json_1 = require("../../package.json");
+const src_1 = require("../../src");
+// import { CLI } from '../../src/lib/cli-forge';
+const fs_1 = require("../utils/fs");
+function withInitArgs(cmd) {
+    return cmd
+        .positional('cliName', {
+        type: 'string',
+        description: 'Name of the CLI to generate.',
+        required: true,
+    })
+        .option('output', {
+        alias: ['o'],
+        type: 'string',
+        description: 'Where should the CLI be created?',
+    })
+        .option('format', {
+        type: 'string',
+        default: 'ts',
+        description: 'What format should the CLI be in? (js, ts)',
+    });
+}
+exports.initCommand = (0, src_1.default)('init', {
+    description: 'Generate a new CLI',
+    builder: (b) => withInitArgs(b),
+    handler: async (args) => {
+        args.output ??= process.cwd();
+        (0, fs_1.ensureDirSync)(args.output);
+        const packageJsonPath = (0, node_path_1.join)(args.output, 'package.json');
+        const cliPath = (0, node_path_1.join)(args.output, 'bin', `${args.cliName}.${args.format}`);
+        const packageJsonContent = readJsonOr(packageJsonPath, { name: args.cliName });
+        packageJsonContent.bin ??= {};
+        packageJsonContent.bin[args.cliName] = (0, node_path_1.relative)(args.output, cliPath);
+        packageJsonContent.dependencies ??= {};
+        packageJsonContent.dependencies['cli-forge'] ??= package_json_1.version;
+        (0, node_fs_1.writeFileSync)(packageJsonPath, JSON.stringify(packageJsonContent, null, 2));
+        (0, fs_1.ensureDirSync)((0, node_path_1.dirname)(cliPath));
+        (0, node_fs_1.writeFileSync)(cliPath, args.format === 'ts'
+            ? TS_CLI_CONTENTS(args.cliName)
+            : JS_CLI_CONTENTS(args.cliName));
+        const installCommand = (0, node_fs_1.existsSync)((0, node_path_1.join)(args.output, 'yarn.lock'))
+            ? 'yarn'
+            : (0, node_fs_1.existsSync)((0, node_path_1.join)(args.output, 'pnpm-lock.yaml'))
+                ? 'pnpm'
+                : (0, node_fs_1.existsSync)((0, node_path_1.join)(args.output, 'bun.lockb'))
+                    ? 'bun'
+                    : 'npm';
+        (0, node_child_process_1.execSync)(`${installCommand} install`);
+    },
+});
+const COMMON_CONTENTS = (name) => `const myCLI = cli('${name}')
+  .command('hello', {
+    builder: (args) => args.positional('name', {type: 'string'}),
+    handler: (args) => {
+      console.log('hello', args.name);
+    }
+  })`;
+const JS_CLI_CONTENTS = (name) => `const { cli } = require('cli-forge');
+
+${COMMON_CONTENTS(name)}
+
+module.exports = myCLI;
+
+if (require.main === module) {
+  myCLI.forge();
+}
+`;
+const TS_CLI_CONTENTS = (name) => `import { cli } from 'cli-forge';
+
+${COMMON_CONTENTS(name)}
+
+export default myCLI;
+
+if (require.main === module) {
+  myCLI.forge();
+}
+`;
+function readJsonOr(filePath, alt) {
+    try {
+        const contents = (0, node_fs_1.readFileSync)(filePath, 'utf-8');
+        return JSON.parse(contents);
+    }
+    catch {
+        return alt;
+    }
+}
+//# sourceMappingURL=init.js.map

package/bin/commands/init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/bin/commands/init.ts"],"names":[],"mappings":";;;AAWA,oCAiBC;AA1BD,2DAA8C;AAC9C,qCAAkE;AAClE,yCAAoD;AAEpD,qDAAkE;AAClE,mCAAqC;AACrC,iDAAiD;AACjD,oCAA4C;AAE5C,SAAgB,YAAY,CAAuB,GAAW;IAC5D,OAAO,GAAG;SACP,UAAU,CAAC,SAAS,EAAE;QACrB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,8BAA8B;QAC3C,QAAQ,EAAE,IAAI;KACf,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,KAAK,EAAE,CAAC,GAAG,CAAC;QACZ,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,kCAAkC;KAChD,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,4CAA4C;KAC1D,CAAC,CAAC;AACP,CAAC;AAEY,QAAA,WAAW,GAAG,IAAA,aAAG,EAAC,MAAM,EAAE;IACrC,WAAW,EAAE,oBAAoB;IACjC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/B,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QACtB,IAAI,CAAC,MAAM,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC;QAC9B,IAAA,kBAAa,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,eAAe,GAAG,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAC1D,MAAM,OAAO,GAAG,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3E,MAAM,kBAAkB,GAMpB,UAAU,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QACxD,kBAAkB,CAAC,GAAG,KAAK,EAAE,CAAC;QAC9B,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,IAAA,oBAAQ,EAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACtE,kBAAkB,CAAC,YAAY,KAAK,EAAE,CAAC;QACvC,kBAAkB,CAAC,YAAY,CAAC,WAAW,CAAC,KAAK,sBAAiB,CAAC;QACnE,IAAA,uBAAa,EAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5E,IAAA,kBAAa,EAAC,IAAA,mBAAO,EAAC,OAAO,CAAC,CAAC,CAAC;QAChC,IAAA,uBAAa,EACX,OAAO,EACP,IAAI,CAAC,MAAM,KAAK,IAAI;YAClB,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC;YAC/B,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAClC,CAAC;QACF,MAAM,cAAc,GAAG,IAAA,oBAAU,EAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YAC/D,CAAC,CAAC,MAAM;YACR,CAAC,CAAC,IAAA,oBAAU,EAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;gBACjD,CAAC,CAAC,MAAM;gBACR,CAAC,CAAC,IAAA,oBAAU,EAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;oBAC5C,CAAC,CAAC,KAAK;oBACP,CAAC,CAAC,KAAK,CAAC;QAEV,IAAA,6BAAQ,EAAC,GAAG,cAAc,UAAU,CAAC,CAAC;IACxC,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,sBAAsB,IAAI;;;;;;KAM/D,CAAC;AAEN,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC;;EAExC,eAAe,CAAC,IAAI,CAAC;;;;;;;CAOtB,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC;;EAExC,eAAe,CAAC,IAAI,CAAC;;;;;;;CAOtB,CAAC;AAEF,SAAS,UAAU,CAAI,QAAgB,EAAE,GAAM;IAC7C,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,IAAA,sBAAY,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,GAAG,CAAC;IACb,CAAC;AACH,CAAC"}

package/bin/utils/fs.d.ts

@@ -0,0 +1 @@
+export declare function ensureDirSync(dir: string): void;

package/bin/utils/fs.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureDirSync = ensureDirSync;
+const node_fs_1 = require("node:fs");
+function ensureDirSync(dir) {
+    try {
+        (0, node_fs_1.mkdirSync)(dir, { recursive: true });
+    }
+    catch (e) {
+        if (!(0, node_fs_1.existsSync)(dir)) {
+            throw new Error(`Could not create directory: ${dir}`, { cause: e });
+        }
+    }
+}
+//# sourceMappingURL=fs.js.map

package/bin/utils/fs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/bin/utils/fs.ts"],"names":[],"mappings":";;AAEA,sCAQC;AAVD,qCAAgD;AAEhD,SAAgB,aAAa,CAAC,GAAW;IACvC,IAAI,CAAC;QACH,IAAA,mBAAS,EAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,IAAI,CAAC,IAAA,oBAAU,EAAC,GAAG,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,+BAA+B,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;AACH,CAAC"}

package/package.json

@@ -1,9 +1,17 @@
 {
   "name": "cli-forge",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "dependencies": {
     "tslib": "^2.3.0",
-    "@cli-forge/parser": "0.2.0"
+    "@cli-forge/parser": "0.4.0"
+  },
+  "peerDependencies": {
+    "markdown-factory": "0.2.0"
+  },
+  "peerDependenciesMeta": {
+    "markdown-factory": {
+      "optional": true
+    }
   },
   "type": "commonjs",
   "main": "./src/index.js",
@@ -14,6 +22,9 @@
     "directory": "packages/cli-forge",
     "url": "https://github.com/AgentEnder/cli-forge"
   },
+  "bin": {
+    "cli-forge": "./bin/cli.js"
+  },
   "publishConfig": {
     "access": "public"
   },

package/src/index.d.ts

@@ -1 +1 @@
-export * from './lib/cli-forge';
+export { default, cli, CLI, Command } from './lib/cli-forge';

package/src/index.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./lib/cli-forge"), exports);
+exports.cli = exports.default = void 0;
+var cli_forge_1 = require("./lib/cli-forge");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return cli_forge_1.default; } });
+Object.defineProperty(exports, "cli", { enumerable: true, get: function () { return cli_forge_1.cli; } });
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/cli-forge/src/index.ts"],"names":[],"mappings":";;;AAAA,0DAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/cli-forge/src/index.ts"],"names":[],"mappings":";;;AAAA,6CAA6D;AAApD,oGAAA,OAAO,OAAA;AAAE,gGAAA,GAAG,OAAA"}

package/src/lib/cli-forge.d.ts

@@ -1,47 +1,34 @@
 import { ArrayOptionConfig, OptionConfig, ParsedArgs } from '@cli-forge/parser';
-export type CLICommandOptions<TInitial extends ParsedArgs, TArgs extends TInitial> = {
+export interface CLIHandlerContext {
+    command: CLI<any>;
+}
+export type CLICommandOptions<TInitial extends ParsedArgs, TArgs extends TInitial = TInitial> = {
     description?: string;
     builder?: (parser: CLI<TInitial>) => CLI<TArgs>;
-    handler: (args: TArgs) => void | Promise<void>;
+    handler: (args: TArgs, context: CLIHandlerContext) => void | Promise<void>;
 };
-/**
- * The base class for a CLI application. This class is used to define the structure of the CLI.
- *
- * {@link cli} is provided as a small helper function to create a new CLI instance.
- *
- * @example
- * ```ts
- * import { cli } from 'cli-forge';
- *
- * cli('basic-cli').command('hello', {
- *   builder: (args) =>
- *    args.option('name', {
- *      type: 'string',
- *    }),
- *   handler: (args) => {
- *     console.log(`Hello, ${args.name}!`);
- *   }).forge();
- * ```
- */
-export declare class CLI<T extends ParsedArgs = ParsedArgs> {
+export type Command<TInitial extends ParsedArgs = any, TArgs extends TInitial = TInitial> = ({
     name: string;
-    protected configuration?: CLICommandOptions<T, T> | undefined;
-    private commands;
-    private commandChain;
-    private requiresCommand;
-    private parser;
-    /**
-     * @param name What should the name of the cli command be?
-     * @param configuration Configuration for the current CLI command.
-     */
-    constructor(name: string, configuration?: CLICommandOptions<T, T> | undefined);
+} & CLICommandOptions<TInitial, TArgs>) | CLI<TArgs>;
+export interface CLI<TArgs extends ParsedArgs = ParsedArgs> {
+    command<TCommandArgs extends TArgs>(cmd: Command<TArgs, TCommandArgs>): CLI<TArgs>;
     /**
      * Registers a new command with the CLI.
      * @param key What should the new command be called?
      * @param options Settings for the new command. See {@link CLICommandOptions}.
      * @returns Updated CLI instance with the new command registered.
      */
-    command<TArgs extends T>(key: string, options: CLICommandOptions<T, TArgs>): this;
+    command<TCommandArgs extends TArgs>(key: string, options: CLICommandOptions<TArgs, TCommandArgs>): CLI<TArgs>;
+    /**
+     * Registers multiple subcommands with the CLI.
+     * @param commands Several commands to register. Can be the result of a call to {@link cli} or a configuration object.
+     */
+    commands(commands: Command[]): CLI<TArgs>;
+    /**
+     * Registers multiple subcommands with the CLI.
+     * @param commands Several commands to register. Can be the result of a call to {@link cli} or a configuration object.
+     */
+    commands(...commands: Command[]): CLI<TArgs>;
     /**
      * Registers a new option for the CLI command. This option will be accessible
      * within the command handler, as well as any subcommands.
@@ -50,12 +37,14 @@ export declare class CLI<T extends ParsedArgs = ParsedArgs> {
      * @param config Configuration for the option. See {@link OptionConfig}.
      * @returns Updated CLI instance with the new option registered.
      */
-    option<TOption extends string, TOptionConfig extends OptionConfig>(name: TOption, config: TOptionConfig): CLI<T & { [key in TOption]: TOptionConfig["coerce"] extends (value: string) => infer TCoerce ? TCoerce : {
-        string: string;
-        number: number;
-        boolean: boolean;
-        array: (TOptionConfig extends ArrayOptionConfig<string | number> ? TOptionConfig["items"] extends "string" ? string : number : never)[];
-    }[TOptionConfig["type"]]; }>;
+    option<TOption extends string, TOptionConfig extends OptionConfig>(name: TOption, config: TOptionConfig): CLI<TArgs & {
+        [key in TOption]: TOptionConfig['coerce'] extends (value: string) => infer TCoerce ? TCoerce : {
+            string: string;
+            number: number;
+            boolean: boolean;
+            array: (TOptionConfig extends ArrayOptionConfig<string | number> ? TOptionConfig['items'] extends 'string' ? string : number : never)[];
+        }[TOptionConfig['type']];
+    }>;
     /**
      * Registers a new positional argument for the CLI command. This argument will be accessible
      * within the command handler, as well as any subcommands.
@@ -63,17 +52,71 @@ export declare class CLI<T extends ParsedArgs = ParsedArgs> {
      * @param config Configuration for the positional argument. See {@link OptionConfig}.
      * @returns Updated CLI instance with the new positional argument registered.
      */
-    positional<TOption extends string, TOptionConfig extends OptionConfig>(name: TOption, config: TOptionConfig): CLI<T & { [key in TOption]: {
-        string: string;
-        number: number;
-        boolean: boolean;
-        array: (TOptionConfig extends ArrayOptionConfig<string | number> ? TOptionConfig["items"] extends "string" ? string : number : never)[];
-    }[TOptionConfig["type"]]; }>;
+    positional<TOption extends string, TOptionConfig extends OptionConfig>(name: TOption, config: TOptionConfig): CLI<TArgs & {
+        [key in TOption]: TOptionConfig['coerce'] extends (value: string) => infer TCoerce ? TCoerce : {
+            string: string;
+            number: number;
+            boolean: boolean;
+            array: (TOptionConfig extends ArrayOptionConfig<string | number> ? TOptionConfig['items'] extends 'string' ? string : number : never)[];
+        }[TOptionConfig['type']];
+    }>;
     /**
      * Requires a command to be provided when executing the CLI. Useful if your parent command
      * cannot be executed on its own.
      * @returns Updated CLI instance.
      */
+    demandCommand(): CLI<TArgs>;
+    /**
+     * Prints help text to stdout.
+     */
+    printHelp(): void;
+    /**
+     * Parses argv and executes the CLI
+     * @param args argv. Defaults to process.argv.slice(2)
+     * @returns Promise that resolves when the handler completes.
+     */
+    forge(args?: string[]): Promise<void>;
+}
+/**
+ * The base class for a CLI application. This class is used to define the structure of the CLI.
+ *
+ * {@link cli} is provided as a small helper function to create a new CLI instance.
+ *
+ * @example
+ * ```ts
+ * import { cli } from 'cli-forge';
+ *
+ * cli('basic-cli').command('hello', {
+ *   builder: (args) =>
+ *    args.option('name', {
+ *      type: 'string',
+ *    }),
+ *   handler: (args) => {
+ *     console.log(`Hello, ${args.name}!`);
+ *   }).forge();
+ * ```
+ */
+export declare class InternalCLI<TArgs extends ParsedArgs = ParsedArgs> implements CLI<TArgs> {
+    name: string;
+    private registeredCommands;
+    private commandChain;
+    private requiresCommand;
+    private _configuration?;
+    private parser;
+    /**
+     * @param name What should the name of the cli command be?
+     * @param configuration Configuration for the current CLI command.
+     */
+    constructor(name: string);
+    get configuration(): CLICommandOptions<any, any> | undefined;
+    private set configuration(value);
+    withRootCommandConfiguration<TRootCommandArgs extends TArgs>(configuration: CLICommandOptions<TArgs, TRootCommandArgs>): InternalCLI<TArgs>;
+    command<TCommandArgs extends TArgs>(cmd: Command<TArgs, TCommandArgs>): CLI<TArgs>;
+    command<TCommandArgs extends TArgs>(key: string, options: CLICommandOptions<TArgs, TCommandArgs>): CLI<TArgs>;
+    commands(commands: Command[]): typeof this;
+    commands(...commands: Command[]): typeof this;
+    option<TOption extends string, TOptionConfig extends OptionConfig>(name: TOption, config: TOptionConfig): any;
+    positional<TOption extends string, TOptionConfig extends OptionConfig>(name: TOption, config: TOptionConfig): any;
     demandCommand(): this;
     /**
      * Gets help text for the current command as a string.
@@ -89,18 +132,24 @@ export declare class CLI<T extends ParsedArgs = ParsedArgs> {
      * @param cmd The command to run.
      * @param args The arguments to pass to the command.
      */
-    runCommand<T extends ParsedArgs>(cmd: CLI<T>, args: T): Promise<void>;
+    runCommand<T extends ParsedArgs>(cmd: InternalCLI<T>, args: T): Promise<void>;
     /**
      * Parses argv and executes the CLI
      * @param args argv. Defaults to process.argv.slice(2)
      * @returns Promise that resolves when the handler completes.
      */
     forge(args?: string[]): Promise<void>;
+    getParser(): import("@cli-forge/parser").ReadonlyArgvParser<TArgs & {
+        help: boolean;
+    }>;
+    getSubcommands(): Readonly<Record<string, InternalCLI>>;
+    clone(): InternalCLI<TArgs>;
 }
 /**
- * Constructs a CLI instance. See {@link CLI} for more information.
+ * Constructs a CLI instance. See {@link InternalCLI} for more information.
  * @param name Name for the top level CLI
- * @returns
+ * @param rootCommandConfiguration Configuration used when running the bare CLI. e.g. npx my-cli, rather than npx my-cli [cmd]
+ * @returns A {@link InternalCLI} instance.
  */
-export declare function cli(name: string): CLI<ParsedArgs>;
+export declare function cli<TArgs extends ParsedArgs>(name: string, rootCommandConfiguration?: CLICommandOptions<ParsedArgs, TArgs>): CLI<TArgs>;
 export default cli;

package/src/lib/cli-forge.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CLI = void 0;
+exports.InternalCLI = void 0;
 exports.cli = cli;
-const tslib_1 = require("tslib");
 const parser_1 = require("@cli-forge/parser");
 /**
  * The base class for a CLI application. This class is used to define the structure of the CLI.
@@ -23,88 +22,100 @@ const parser_1 = require("@cli-forge/parser");
  *   }).forge();
  * ```
  */
-class CLI {
+class InternalCLI {
+    name;
+    registeredCommands = {};
+    commandChain = [];
+    requiresCommand = false;
+    _configuration;
+    parser = new parser_1.ArgvParser({
+        unmatchedParser: (arg) => {
+            // eslint-disable-next-line @typescript-eslint/no-this-alias
+            let currentCommand = this;
+            for (const command of this.commandChain) {
+                currentCommand = currentCommand.registeredCommands[command];
+            }
+            const command = currentCommand.registeredCommands[arg];
+            if (command && command.configuration) {
+                command.configuration.builder?.(command);
+                this.commandChain.push(arg);
+                return true;
+            }
+            return false;
+        },
+    }).option('help', {
+        type: 'boolean',
+        alias: ['h'],
+        description: 'Show help for the current command',
+    });
     /**
      * @param name What should the name of the cli command be?
      * @param configuration Configuration for the current CLI command.
      */
-    constructor(name, configuration) {
+    constructor(name) {
         this.name = name;
+    }
+    get configuration() {
+        return this._configuration;
+    }
+    set configuration(value) {
+        this._configuration = value;
+    }
+    withRootCommandConfiguration(configuration) {
         this.configuration = configuration;
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        this.commands = {};
-        this.commandChain = [];
-        this.requiresCommand = false;
-        this.parser = new parser_1.ArgvParser({
-            unmatchedParser: (arg) => {
-                var _a, _b;
-                // eslint-disable-next-line @typescript-eslint/no-this-alias, @typescript-eslint/no-explicit-any
-                let currentCommand = this;
-                for (const command of this.commandChain) {
-                    currentCommand = currentCommand.commands[command];
-                }
-                const command = currentCommand.commands[arg];
-                if (command && command.configuration) {
-                    (_b = (_a = command.configuration).builder) === null || _b === void 0 ? void 0 : _b.call(_a, command);
-                    this.commandChain.push(arg);
-                    return true;
-                }
-                return false;
-            },
-        }).option('help', {
-            type: 'boolean',
-            alias: ['-h'],
-            description: 'Show help for the current command',
-        });
+        return this;
     }
-    /**
-     * Registers a new command with the CLI.
-     * @param key What should the new command be called?
-     * @param options Settings for the new command. See {@link CLICommandOptions}.
-     * @returns Updated CLI instance with the new command registered.
-     */
-    command(key, options) {
-        if (key === '$0') {
-            this.configuration = Object.assign(Object.assign({}, this.configuration), { 
-                // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                builder: options.builder, 
-                // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                handler: options.handler, description: options.description });
-        }
-        this.commands[key] = new CLI(key, options);
-        this.commands[key].parser = this.parser;
+    command(keyOrCommand, options) {
+        if (typeof keyOrCommand === 'string') {
+            const key = keyOrCommand;
+            if (!options) {
+                throw new Error('options must be provided when calling `command` with a string');
+            }
+            if (key === '$0') {
+                this.configuration = {
+                    ...this.configuration,
+                    builder: options.builder,
+                    handler: options.handler,
+                    description: options.description,
+                };
+            }
+            this.registeredCommands[key] = new InternalCLI(key).withRootCommandConfiguration(options);
+            this.registeredCommands[key].parser = this.parser;
+        }
+        else if (keyOrCommand instanceof InternalCLI) {
+            const cmd = keyOrCommand;
+            this.registeredCommands[cmd.name] = cmd;
+        }
+        else {
+            const { name, ...configuration } = keyOrCommand;
+            this.command(name, configuration);
+        }
+        return this;
+    }
+    commands(...a0) {
+        const commands = a0.flat();
+        for (const val of commands) {
+            if (val instanceof InternalCLI) {
+                this.registeredCommands[val.name] = val;
+                // Include any options that were defined via cli(...).option() instead of via builder
+                this.parser.augment(val.parser);
+                val.parser = this.parser;
+            }
+            else {
+                const { name, ...configuration } = val;
+                this.command(name, configuration);
+            }
+        }
         return this;
     }
-    /**
-     * Registers a new option for the CLI command. This option will be accessible
-     * within the command handler, as well as any subcommands.
-     *
-     * @param name The name of the option.
-     * @param config Configuration for the option. See {@link OptionConfig}.
-     * @returns Updated CLI instance with the new option registered.
-     */
     option(name, config) {
         this.parser.option(name, config);
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         return this;
     }
-    /**
-     * Registers a new positional argument for the CLI command. This argument will be accessible
-     * within the command handler, as well as any subcommands.
-     * @param name The name of the positional argument.
-     * @param config Configuration for the positional argument. See {@link OptionConfig}.
-     * @returns Updated CLI instance with the new positional argument registered.
-     */
     positional(name, config) {
-        this.parser.option(name, config);
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        this.parser.positional(name, config);
         return this;
     }
-    /**
-     * Requires a command to be provided when executing the CLI. Useful if your parent command
-     * cannot be executed on its own.
-     * @returns Updated CLI instance.
-     */
     demandCommand() {
         this.requiresCommand = true;
         return this;
@@ -114,24 +125,27 @@ class CLI {
      * @returns Help text for the current command.
      */
     formatHelp() {
-        var _a, _b;
         const help = [];
         // eslint-disable-next-line @typescript-eslint/no-this-alias
         let command = this;
         for (const key of this.commandChain) {
-            command = command.commands[key];
+            command = command.registeredCommands[key];
         }
-        help.push(`Usage: ${[this.name, ...this.commandChain].join(' ')}`);
-        if ((_a = command.configuration) === null || _a === void 0 ? void 0 : _a.description) {
+        help.push(`Usage: ${[
+            this.name,
+            ...this.commandChain,
+            ...command.parser.configuredPositionals.map((p) => `[${p.key}]`),
+        ].join(' ')}`);
+        if (command.configuration?.description) {
             help.push(command.configuration.description);
         }
-        if (Object.keys(command.commands).length > 0) {
+        if (Object.keys(command.registeredCommands).length > 0) {
             help.push('');
             help.push('Commands:');
         }
-        for (const key in command.commands) {
-            const subcommand = command.commands[key];
-            help.push(`  ${key}${((_b = subcommand.configuration) === null || _b === void 0 ? void 0 : _b.description)
+        for (const key in command.registeredCommands) {
+            const subcommand = command.registeredCommands[key];
+            help.push(`  ${key}${subcommand.configuration?.description
                 ? ' - ' + subcommand.configuration.description
                 : ''}`);
         }
@@ -140,11 +154,10 @@ class CLI {
             help.push('Options:');
         }
         for (const key in this.parser.configuredOptions) {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             const option = this.parser.configuredOptions[key];
             help.push(`  --${key}${option.description ? ' - ' + option.description : ''}`);
         }
-        if (Object.keys(command.commands).length > 0) {
+        if (Object.keys(command.registeredCommands).length > 0) {
             help.push(' ');
             help.push(`Run \`${[this.name, ...this.commandChain].join(' ')} [command] --help\` for more information on a command`);
         }
@@ -161,62 +174,82 @@ class CLI {
      * @param cmd The command to run.
      * @param args The arguments to pass to the command.
      */
-    runCommand(cmd, args) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            var _a;
-            try {
-                if (cmd.requiresCommand) {
-                    throw new Error(`${[this.name, ...this.commandChain].join(' ')} requires a command`);
-                }
-                if ((_a = cmd.configuration) === null || _a === void 0 ? void 0 : _a.handler) {
-                    yield cmd.configuration.handler(args);
-                }
-                else {
-                    throw new Error(`${[this.name, ...this.commandChain].join(' ')} is not implemented.`);
-                }
+    async runCommand(cmd, args) {
+        try {
+            if (cmd.requiresCommand) {
+                throw new Error(`${[this.name, ...this.commandChain].join(' ')} requires a command`);
             }
-            catch (_b) {
-                process.exitCode = 1;
-                this.printHelp();
+            if (cmd.configuration?.handler) {
+                await cmd.configuration.handler(args, {
+                    command: cmd,
+                });
             }
-        });
+            else {
+                throw new Error(`${[this.name, ...this.commandChain].join(' ')} is not implemented.`);
+            }
+        }
+        catch (e) {
+            process.exitCode = 1;
+            console.error(e);
+            this.printHelp();
+        }
     }
     /**
      * Parses argv and executes the CLI
      * @param args argv. Defaults to process.argv.slice(2)
      * @returns Promise that resolves when the handler completes.
      */
-    forge() {
-        return tslib_1.__awaiter(this, arguments, void 0, function* (args = process.argv.slice(2)) {
-            var _a, _b, _c;
-            // Parsing the args does two things:
-            // - builds argv to pass to handler
-            // - fills the command chain + registers commands
-            const argv = this.parser.parse(args);
-            // eslint-disable-next-line @typescript-eslint/no-this-alias, @typescript-eslint/no-explicit-any
-            let currentCommand = this;
-            for (const command of this.commandChain) {
-                currentCommand = currentCommand.commands[command];
-            }
-            if (argv.help) {
-                this.printHelp();
-                return;
-            }
-            const finalArgV = currentCommand === this
-                ? ((_c = (_b = (_a = this.configuration) === null || _a === void 0 ? void 0 : _a.builder) === null || _b === void 0 ? void 0 : _b.call(_a, this).parser) !== null && _c !== void 0 ? _c : this.parser).parse(args)
-                : argv;
-            yield this.runCommand(currentCommand, finalArgV);
-        });
+    async forge(args = process.argv.slice(2)) {
+        // Parsing the args does two things:
+        // - builds argv to pass to handler
+        // - fills the command chain + registers commands
+        const argv = this.parser.parse(args);
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        let currentCommand = this;
+        for (const command of this.commandChain) {
+            currentCommand = currentCommand.registeredCommands[command];
+        }
+        if (argv.help) {
+            this.printHelp();
+            return;
+        }
+        const finalArgV = currentCommand === this
+            ? (this.configuration?.builder?.(this)
+                ?.parser ?? this.parser).parse(args)
+            : argv;
+        await this.runCommand(currentCommand, finalArgV);
+    }
+    getParser() {
+        return this.parser.asReadonly();
+    }
+    getSubcommands() {
+        return this.registeredCommands;
+    }
+    clone() {
+        const clone = new InternalCLI(this.name);
+        if (this.configuration) {
+            clone.withRootCommandConfiguration(this.configuration);
+        }
+        clone.registeredCommands = { ...this.registeredCommands };
+        clone.commandChain = [...this.commandChain];
+        clone.requiresCommand = this.requiresCommand;
+        clone.parser = this.parser.clone();
+        return clone;
     }
 }
-exports.CLI = CLI;
+exports.InternalCLI = InternalCLI;
 /**
- * Constructs a CLI instance. See {@link CLI} for more information.
+ * Constructs a CLI instance. See {@link InternalCLI} for more information.
  * @param name Name for the top level CLI
- * @returns
+ * @param rootCommandConfiguration Configuration used when running the bare CLI. e.g. npx my-cli, rather than npx my-cli [cmd]
+ * @returns A {@link InternalCLI} instance.
  */
-function cli(name) {
-    return new CLI(name);
+function cli(name, rootCommandConfiguration) {
+    const cli = new InternalCLI(name);
+    if (rootCommandConfiguration) {
+        cli.withRootCommandConfiguration(rootCommandConfiguration);
+    }
+    return cli;
 }
 exports.default = cli;
 //# sourceMappingURL=cli-forge.js.map

package/src/lib/cli-forge.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli-forge.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/src/lib/cli-forge.ts"],"names":[],"mappings":";;;AAgSA,kBAEC;;AAlSD,8CAK2B;AAW3B;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,GAAG;IA0Bd;;;OAGG;IACH,YACS,IAAY,EACT,aAAuC;QAD1C,SAAI,GAAJ,IAAI,CAAQ;QACT,kBAAa,GAAb,aAAa,CAA0B;QA/BnD,8DAA8D;QACtD,aAAQ,GAA6B,EAAE,CAAC;QACxC,iBAAY,GAAa,EAAE,CAAC;QAC5B,oBAAe,GAAG,KAAK,CAAC;QACxB,WAAM,GAAG,IAAI,mBAAU,CAAI;YACjC,eAAe,EAAE,CAAC,GAAG,EAAE,EAAE;;gBACvB,gGAAgG;gBAChG,IAAI,cAAc,GAAa,IAAI,CAAC;gBACpC,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;oBACxC,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;gBACpD,CAAC;gBACD,MAAM,OAAO,GAAG,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAC7C,IAAI,OAAO,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;oBACrC,MAAA,MAAA,OAAO,CAAC,aAAa,EAAC,OAAO,mDAAG,OAAO,CAAC,CAAC;oBACzC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBAC5B,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;SACF,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE;YAChB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,CAAC,IAAI,CAAC;YACb,WAAW,EAAE,mCAAmC;SACjD,CAAC,CAAC;IASA,CAAC;IAEJ;;;;;OAKG;IACH,OAAO,CAAkB,GAAW,EAAE,OAAoC;QACxE,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,IAAI,CAAC,aAAa,mCACb,IAAI,CAAC,aAAa;gBACrB,8DAA8D;gBAC9D,OAAO,EAAE,OAAO,CAAC,OAAc;gBAC/B,8DAA8D;gBAC9D,OAAO,EAAE,OAAO,CAAC,OAAc,EAC/B,WAAW,EAAE,OAAO,CAAC,WAAW,GACjC,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAQ,GAAG,EAAE,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,IAAa,EACb,MAAqB;QAErB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACjC,8DAA8D;QAC9D,OAAO,IAiBN,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CACR,IAAa,EACb,MAAqB;QAErB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACjC,8DAA8D;QAC9D,OAAO,IAaN,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,aAAa;QACX,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,UAAU;;QACR,MAAM,IAAI,GAAa,EAAE,CAAC;QAC1B,4DAA4D;QAC5D,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACpC,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAgB,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACnE,IAAI,MAAA,OAAO,CAAC,aAAa,0CAAE,WAAW,EAAE,CAAC;YACvC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzB,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACnC,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACzC,IAAI,CAAC,IAAI,CACP,KAAK,GAAG,GACN,CAAA,MAAA,UAAU,CAAC,aAAa,0CAAE,WAAW;gBACnC,CAAC,CAAC,KAAK,GAAG,UAAU,CAAC,aAAa,CAAC,WAAW;gBAC9C,CAAC,CAAC,EACN,EAAE,CACH,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1D,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxB,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC;YAChD,8DAA8D;YAC9D,MAAM,MAAM,GAAI,IAAI,CAAC,MAAM,CAAC,iBAAyB,CACnD,GAAG,CACY,CAAC;YAClB,IAAI,CAAC,IAAI,CACP,OAAO,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,CACpE,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACf,IAAI,CAAC,IAAI,CACP,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAC7C,GAAG,CACJ,uDAAuD,CACzD,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACG,UAAU,CAAuB,GAAW,EAAE,IAAO;;;YACzD,IAAI,CAAC;gBACH,IAAI,GAAG,CAAC,eAAe,EAAE,CAAC;oBACxB,MAAM,IAAI,KAAK,CACb,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,qBAAqB,CACpE,CAAC;gBACJ,CAAC;gBACD,IAAI,MAAA,GAAG,CAAC,aAAa,0CAAE,OAAO,EAAE,CAAC;oBAC/B,MAAM,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACxC,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CACb,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,sBAAsB,CACrE,CAAC;gBACJ,CAAC;YACH,CAAC;YAAC,WAAM,CAAC;gBACP,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACrB,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,CAAC;QACH,CAAC;KAAA;IAED;;;;OAIG;IACG,KAAK;qEAAC,OAAiB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;;YAChD,oCAAoC;YACpC,mCAAmC;YACnC,iDAAiD;YACjD,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACrC,gGAAgG;YAChG,IAAI,cAAc,GAAa,IAAI,CAAC;YACpC,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACxC,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YACpD,CAAC;YACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,IAAI,CAAC,SAAS,EAAE,CAAC;gBACjB,OAAO;YACT,CAAC;YAED,MAAM,SAAS,GACb,cAAc,KAAK,IAAI;gBACrB,CAAC,CAAC,CAAC,MAAA,MAAA,MAAA,IAAI,CAAC,aAAa,0CAAE,OAAO,mDAAG,IAAI,EAAE,MAAM,mCAAI,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,CAC/D,IAAI,CACL;gBACH,CAAC,CAAC,IAAI,CAAC;YAEX,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;QACnD,CAAC;KAAA;CACF;AAtPD,kBAsPC;AAED;;;;GAIG;AACH,SAAgB,GAAG,CAAC,IAAY;IAC9B,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;AACvB,CAAC;AAED,kBAAe,GAAG,CAAC"}
+{"version":3,"file":"cli-forge.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/src/lib/cli-forge.ts"],"names":[],"mappings":";;;AA2bA,kBAWC;AAtcD,8CAK2B;AAkI3B;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,WAAW;IAkCH;IA/BX,kBAAkB,GAAqC,EAAE,CAAC;IAC1D,YAAY,GAAa,EAAE,CAAC;IAC5B,eAAe,GAAG,KAAK,CAAC;IAExB,cAAc,CAA+B;IAE7C,MAAM,GAAG,IAAI,mBAAU,CAAQ;QACrC,eAAe,EAAE,CAAC,GAAG,EAAE,EAAE;YACvB,4DAA4D;YAC5D,IAAI,cAAc,GAAqB,IAAI,CAAC;YAC5C,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACxC,cAAc,GAAG,cAAc,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAC9D,CAAC;YACD,MAAM,OAAO,GAAG,cAAc,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;YACvD,IAAI,OAAO,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;gBACrC,OAAO,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC;gBACzC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC5B,OAAO,IAAI,CAAC;YACd,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;KACF,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,CAAC,GAAG,CAAC;QACZ,WAAW,EAAE,mCAAmC;KACjD,CAAC,CAAC;IAEH;;;OAGG;IACH,YAAmB,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAEnC,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,IAAY,aAAa,CAAC,KAA8C;QACtE,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;IAC9B,CAAC;IAED,4BAA4B,CAC1B,aAAyD;QAEzD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAWD,OAAO,CACL,YAAmD,EACnD,OAAgD;QAEhD,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;YACrC,MAAM,GAAG,GAAG,YAAY,CAAC;YACzB,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;YACJ,CAAC;YACD,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBACjB,IAAI,CAAC,aAAa,GAAG;oBACnB,GAAG,IAAI,CAAC,aAAa;oBACrB,OAAO,EAAE,OAAO,CAAC,OAAc;oBAC/B,OAAO,EAAE,OAAO,CAAC,OAAc;oBAC/B,WAAW,EAAE,OAAO,CAAC,WAAW;iBACjC,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,IAAI,WAAW,CAC5C,GAAG,CACJ,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC;YACxC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACpD,CAAC;aAAM,IAAI,YAAY,YAAY,WAAW,EAAE,CAAC;YAC/C,MAAM,GAAG,GAAG,YAAY,CAAC;YACzB,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,MAAM,EAAE,IAAI,EAAE,GAAG,aAAa,EAAE,GAAG,YAEO,CAAC;YAC3C,IAAI,CAAC,OAAO,CAAe,IAAI,EAAE,aAAa,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAID,QAAQ,CAAC,GAAG,EAA2B;QACrC,MAAM,QAAQ,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC;QAC3B,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC3B,IAAI,GAAG,YAAY,WAAW,EAAE,CAAC;gBAC/B,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;gBACxC,qFAAqF;gBACrF,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAChC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACN,MAAM,EAAE,IAAI,EAAE,GAAG,aAAa,EAAE,GAAG,GAEJ,CAAC;gBAChC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CACJ,IAAa,EACb,MAAqB;QAErB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACjC,OAAO,IAAW,CAAC;IACrB,CAAC;IAED,UAAU,CACR,IAAa,EACb,MAAqB;QAErB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACrC,OAAO,IAAW,CAAC;IACrB,CAAC;IAED,aAAa;QACX,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,MAAM,IAAI,GAAa,EAAE,CAAC;QAC1B,4DAA4D;QAC5D,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACpC,OAAO,GAAG,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAgB,CAAC;QAC3D,CAAC;QACD,IAAI,CAAC,IAAI,CACP,UAAU;YACR,IAAI,CAAC,IAAI;YACT,GAAG,IAAI,CAAC,YAAY;YACpB,GAAG,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;SACjE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CACd,CAAC;QACF,IAAI,OAAO,CAAC,aAAa,EAAE,WAAW,EAAE,CAAC;YACvC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzB,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;YAC7C,MAAM,UAAU,GAAG,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;YACnD,IAAI,CAAC,IAAI,CACP,KAAK,GAAG,GACN,UAAU,CAAC,aAAa,EAAE,WAAW;gBACnC,CAAC,CAAC,KAAK,GAAG,UAAU,CAAC,aAAa,CAAC,WAAW;gBAC9C,CAAC,CAAC,EACN,EAAE,CACH,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1D,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxB,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC;YAChD,MAAM,MAAM,GAAI,IAAI,CAAC,MAAM,CAAC,iBAAyB,CACnD,GAAG,CACY,CAAC;YAClB,IAAI,CAAC,IAAI,CACP,OAAO,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,CACpE,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACf,IAAI,CAAC,IAAI,CACP,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAC7C,GAAG,CACJ,uDAAuD,CACzD,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAuB,GAAmB,EAAE,IAAO;QACjE,IAAI,CAAC;YACH,IAAI,GAAG,CAAC,eAAe,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CACb,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,qBAAqB,CACpE,CAAC;YACJ,CAAC;YACD,IAAI,GAAG,CAAC,aAAa,EAAE,OAAO,EAAE,CAAC;gBAC/B,MAAM,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE;oBACpC,OAAO,EAAE,GAAG;iBACb,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CACb,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,sBAAsB,CACrE,CAAC;YACJ,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACjB,IAAI,CAAC,SAAS,EAAE,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,OAAiB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAChD,oCAAoC;QACpC,mCAAmC;QACnC,iDAAiD;QACjD,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACrC,4DAA4D;QAC5D,IAAI,cAAc,GAAqB,IAAI,CAAC;QAC5C,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACxC,cAAc,GAAG,cAAc,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC9D,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GACb,cAAc,KAAK,IAAI;YACrB,CAAC,CAAC,CACG,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,CAAC,IAAW,CAAwB;gBAChE,EAAE,MAAM,IAAI,IAAI,CAAC,MAAM,CAC1B,CAAC,KAAK,CAAC,IAAI,CAAC;YACf,CAAC,CAAC,IAAI,CAAC;QAEX,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;IACnD,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;IAClC,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,kBAA2D,CAAC;IAC1E,CAAC;IAED,KAAK;QACH,MAAM,KAAK,GAAG,IAAI,WAAW,CAAQ,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACzD,CAAC;QACD,KAAK,CAAC,kBAAkB,GAAG,EAAE,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1D,KAAK,CAAC,YAAY,GAAG,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5C,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC7C,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAS,CAAC;QAC1C,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAzRD,kCAyRC;AAED;;;;;GAKG;AACH,SAAgB,GAAG,CACjB,IAAY,EACZ,wBAA+D;IAE/D,MAAM,GAAG,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;IAElC,IAAI,wBAAwB,EAAE,CAAC;QAC7B,GAAG,CAAC,4BAA4B,CAAC,wBAAwB,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,GAAiB,CAAC;AAC3B,CAAC;AAED,kBAAe,GAAG,CAAC"}

package/src/lib/documentation.d.ts

@@ -0,0 +1,36 @@
+import { OptionConfig } from '@cli-forge/parser';
+import { InternalCLI } from './cli-forge';
+export type Documentation = {
+    name: string;
+    description?: string;
+    options: Readonly<Record<string, OptionConfig & {
+        key: string;
+    }>>;
+    positionals: readonly Readonly<OptionConfig & {
+        key: string;
+    }>[];
+    subcommands: Documentation[];
+};
+export declare function generateDocumentation(cli: InternalCLI): {
+    name: string;
+    description: string | undefined;
+    options: Readonly<{
+        unmatched: OptionConfig<any> & {
+            key: string;
+            position?: number;
+        };
+        '--'?: (OptionConfig<any> & {
+            key: string;
+            position?: number;
+        }) | undefined;
+        help: OptionConfig<any> & {
+            key: string;
+            position?: number;
+        };
+    }>;
+    positionals: readonly Readonly<OptionConfig<any> & {
+        key: string;
+        position?: number;
+    }>[];
+    subcommands: Documentation[];
+};

package/src/lib/documentation.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateDocumentation = generateDocumentation;
+function generateDocumentation(cli) {
+    // Ensure current command's options are built.
+    if (cli.configuration?.builder) {
+        cli.configuration.builder(cli);
+    }
+    const parser = cli.getParser();
+    const options = parser.configuredOptions;
+    const positionals = parser.configuredPositionals;
+    const subcommands = Object.values(cli.getSubcommands()).map((cmd) => generateDocumentation(cmd.clone()));
+    return {
+        name: cli.name,
+        description: cli.configuration?.description,
+        options,
+        positionals,
+        subcommands,
+    };
+}
+//# sourceMappingURL=documentation.js.map

package/src/lib/documentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentation.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/src/lib/documentation.ts"],"names":[],"mappings":";;AAWA,sDAoBC;AApBD,SAAgB,qBAAqB,CAAC,GAAgB;IACpD,8CAA8C;IAC9C,IAAI,GAAG,CAAC,aAAa,EAAE,OAAO,EAAE,CAAC;QAC/B,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;IACD,MAAM,MAAM,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;IAE/B,MAAM,OAAO,GAAG,MAAM,CAAC,iBAAiB,CAAC;IACzC,MAAM,WAAW,GAAG,MAAM,CAAC,qBAAqB,CAAC;IACjD,MAAM,WAAW,GAAoB,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,GAAG,CAC1E,CAAC,GAAG,EAAE,EAAE,CAAC,qBAAqB,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAC5C,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,WAAW,EAAE,GAAG,CAAC,aAAa,EAAE,WAAW;QAC3C,OAAO;QACP,WAAW;QACX,WAAW;KACZ,CAAC;AACJ,CAAC"}