docstar-cli 0.0.0

package/README.md

@@ -0,0 +1,456 @@
+docstar-cli
+=================
+
+A new CLI generated with oclif
+
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/docstar-cli.svg)](https://npmjs.org/package/docstar-cli)
+[![Downloads/week](https://img.shields.io/npm/dw/docstar-cli.svg)](https://npmjs.org/package/docstar-cli)
+
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g docstar-cli
+$ docstar-cli COMMAND
+running command...
+$ docstar-cli (--version)
+docstar-cli/0.0.0 darwin-arm64 node-v22.22.3
+$ docstar-cli --help [COMMAND]
+USAGE
+  $ docstar-cli COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`docstar-cli hello PERSON`](#docstar-cli-hello-person)
+* [`docstar-cli hello world`](#docstar-cli-hello-world)
+* [`docstar-cli help [COMMAND]`](#docstar-cli-help-command)
+* [`docstar-cli init DOMAIN`](#docstar-cli-init-domain)
+* [`docstar-cli plugins`](#docstar-cli-plugins)
+* [`docstar-cli plugins add PLUGIN`](#docstar-cli-plugins-add-plugin)
+* [`docstar-cli plugins:inspect PLUGIN...`](#docstar-cli-pluginsinspect-plugin)
+* [`docstar-cli plugins install PLUGIN`](#docstar-cli-plugins-install-plugin)
+* [`docstar-cli plugins link PATH`](#docstar-cli-plugins-link-path)
+* [`docstar-cli plugins remove [PLUGIN]`](#docstar-cli-plugins-remove-plugin)
+* [`docstar-cli plugins reset`](#docstar-cli-plugins-reset)
+* [`docstar-cli plugins uninstall [PLUGIN]`](#docstar-cli-plugins-uninstall-plugin)
+* [`docstar-cli plugins unlink [PLUGIN]`](#docstar-cli-plugins-unlink-plugin)
+* [`docstar-cli plugins update`](#docstar-cli-plugins-update)
+* [`docstar-cli slack list`](#docstar-cli-slack-list)
+* [`docstar-cli slack send-message-1`](#docstar-cli-slack-send-message-1)
+
+## `docstar-cli hello PERSON`
+
+Say hello
+
+```
+USAGE
+  $ docstar-cli hello PERSON -f <value>
+
+ARGUMENTS
+  PERSON  Person to say hello to
+
+FLAGS
+  -f, --from=<value>  (required) Who is saying hello
+
+DESCRIPTION
+  Say hello
+
+EXAMPLES
+  $ docstar-cli hello friend --from oclif
+  hello friend from oclif! (./src/commands/hello/index.ts)
+```
+
+_See code: [src/commands/hello/index.ts](https://github.com/swayammaheshwari/docstar-cli/blob/v0.0.0/src/commands/hello/index.ts)_
+
+## `docstar-cli hello world`
+
+Say hello world
+
+```
+USAGE
+  $ docstar-cli hello world
+
+DESCRIPTION
+  Say hello world
+
+EXAMPLES
+  $ docstar-cli hello world
+  hello world! (./src/commands/hello/world.ts)
+```
+
+_See code: [src/commands/hello/world.ts](https://github.com/swayammaheshwari/docstar-cli/blob/v0.0.0/src/commands/hello/world.ts)_
+
+## `docstar-cli help [COMMAND]`
+
+Display help for docstar-cli.
+
+```
+USAGE
+  $ docstar-cli help [COMMAND...] [-n]
+
+ARGUMENTS
+  [COMMAND...]  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for docstar-cli.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.58/src/commands/help.ts)_
+
+## `docstar-cli init DOMAIN`
+
+Discover published modules for a DocStar docs site, pick which ones to install, and register their CLI commands
+
+```
+USAGE
+  $ docstar-cli init DOMAIN [--collectionId <value>]
+
+ARGUMENTS
+  DOMAIN  DocStar docs domain, e.g. docs.msg91.com or localhost:3000
+
+FLAGS
+  --collectionId=<value>  Collection id (required when the domain is not a custom domain, e.g. localhost)
+
+DESCRIPTION
+  Discover published modules for a DocStar docs site, pick which ones to install, and register their CLI commands
+
+EXAMPLES
+  $ docstar-cli init docs.msg91.com
+
+  $ docstar-cli init localhost:3000 --collectionId paM4R4A26Hvb
+```
+
+_See code: [src/commands/init.ts](https://github.com/swayammaheshwari/docstar-cli/blob/v0.0.0/src/commands/init.ts)_
+
+## `docstar-cli plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ docstar-cli plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ docstar-cli plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.87/src/commands/plugins/index.ts)_
+
+## `docstar-cli plugins add PLUGIN`
+
+Installs a plugin into docstar-cli.
+
+```
+USAGE
+  $ docstar-cli plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN...  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into docstar-cli.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the DOCSTAR_CLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the DOCSTAR_CLI_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ docstar-cli plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ docstar-cli plugins add myplugin
+
+  Install a plugin from a github url.
+
+    $ docstar-cli plugins add https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ docstar-cli plugins add someuser/someplugin
+```
+
+## `docstar-cli plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ docstar-cli plugins inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN...  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+EXAMPLES
+  $ docstar-cli plugins inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.87/src/commands/plugins/inspect.ts)_
+
+## `docstar-cli plugins install PLUGIN`
+
+Installs a plugin into docstar-cli.
+
+```
+USAGE
+  $ docstar-cli plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN...  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into docstar-cli.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the DOCSTAR_CLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the DOCSTAR_CLI_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ docstar-cli plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ docstar-cli plugins install myplugin
+
+  Install a plugin from a github url.
+
+    $ docstar-cli plugins install https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ docstar-cli plugins install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.87/src/commands/plugins/install.ts)_
+
+## `docstar-cli plugins link PATH`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ docstar-cli plugins link PATH [-h] [--install] [-v]
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help          Show CLI help.
+  -v, --verbose
+      --[no-]install  Install dependencies after linking the plugin.
+
+DESCRIPTION
+  Links a plugin into the CLI for development.
+
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
+EXAMPLES
+  $ docstar-cli plugins link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.87/src/commands/plugins/link.ts)_
+
+## `docstar-cli plugins remove [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ docstar-cli plugins remove [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  [PLUGIN...]  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ docstar-cli plugins unlink
+  $ docstar-cli plugins remove
+
+EXAMPLES
+  $ docstar-cli plugins remove myplugin
+```
+
+## `docstar-cli plugins reset`
+
+Remove all user-installed and linked plugins.
+
+```
+USAGE
+  $ docstar-cli plugins reset [--hard] [--reinstall]
+
+FLAGS
+  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
+  --reinstall  Reinstall all plugins after uninstalling.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.87/src/commands/plugins/reset.ts)_
+
+## `docstar-cli plugins uninstall [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ docstar-cli plugins uninstall [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  [PLUGIN...]  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ docstar-cli plugins unlink
+  $ docstar-cli plugins remove
+
+EXAMPLES
+  $ docstar-cli plugins uninstall myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.87/src/commands/plugins/uninstall.ts)_
+
+## `docstar-cli plugins unlink [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ docstar-cli plugins unlink [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  [PLUGIN...]  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ docstar-cli plugins unlink
+  $ docstar-cli plugins remove
+
+EXAMPLES
+  $ docstar-cli plugins unlink myplugin
+```
+
+## `docstar-cli plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ docstar-cli plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.87/src/commands/plugins/update.ts)_
+
+## `docstar-cli slack list`
+
+List installed APIs for the slack module
+
+```
+USAGE
+  $ docstar-cli slack list
+
+DESCRIPTION
+  List installed APIs for the slack module
+```
+
+_See code: [src/commands/slack/list.ts](https://github.com/swayammaheshwari/docstar-cli/blob/v0.0.0/src/commands/slack/list.ts)_
+
+## `docstar-cli slack send-message-1`
+
+send message
+
+```
+USAGE
+  $ docstar-cli slack send-message-1 [--MY_SECRET_KEY <value>]
+
+FLAGS
+  --MY_SECRET_KEY=<value>  Required parameter
+
+DESCRIPTION
+  send message
+```
+
+_See code: [src/commands/slack/send-message-1.ts](https://github.com/swayammaheshwari/docstar-cli/blob/v0.0.0/src/commands/slack/send-message-1.ts)_
+<!-- commandsstop -->

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
+
+import {execute} from '@oclif/core'
+
+await execute({development: true, dir: import.meta.url})

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {execute} from '@oclif/core'
+
+await execute({dir: import.meta.url})

package/dist/commands/hello/index.d.ts

@@ -0,0 +1,12 @@
+import { Command } from '@oclif/core';
+export default class Hello extends Command {
+    static args: {
+        person: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        from: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/hello/index.js

@@ -0,0 +1,19 @@
+import { Args, Command, Flags } from '@oclif/core';
+export default class Hello extends Command {
+    static args = {
+        person: Args.string({ description: 'Person to say hello to', required: true }),
+    };
+    static description = 'Say hello';
+    static examples = [
+        `<%= config.bin %> <%= command.id %> friend --from oclif
+hello friend from oclif! (./src/commands/hello/index.ts)
+`,
+    ];
+    static flags = {
+        from: Flags.string({ char: 'f', description: 'Who is saying hello', required: true }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(Hello);
+        this.log(`hello ${args.person} from ${flags.from}! (./src/commands/hello/index.ts)`);
+    }
+}

package/dist/commands/hello/world.d.ts

@@ -0,0 +1,8 @@
+import { Command } from '@oclif/core';
+export default class World extends Command {
+    static args: {};
+    static description: string;
+    static examples: string[];
+    static flags: {};
+    run(): Promise<void>;
+}

package/dist/commands/hello/world.js

@@ -0,0 +1,14 @@
+import { Command } from '@oclif/core';
+export default class World extends Command {
+    static args = {};
+    static description = 'Say hello world';
+    static examples = [
+        `<%= config.bin %> <%= command.id %>
+hello world! (./src/commands/hello/world.ts)
+`,
+    ];
+    static flags = {};
+    async run() {
+        this.log('hello world! (./src/commands/hello/world.ts)');
+    }
+}

package/dist/commands/init.d.ts

@@ -0,0 +1,12 @@
+import { Command } from '@oclif/core';
+export default class Init extends Command {
+    static args: {
+        domain: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        collectionId: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/init.js

@@ -0,0 +1,79 @@
+import { checkbox } from '@inquirer/prompts';
+import { Args, Command, Flags } from '@oclif/core';
+import { mkdir, writeFile } from 'node:fs/promises';
+import { generateCommandFile, generateListCommandFile } from '../lib/codegen.js';
+import { configDir, configPath, modulePath } from '../lib/paths.js';
+const buildBaseUrl = (domain) => {
+    if (domain.startsWith('http://') || domain.startsWith('https://'))
+        return domain.replace(/\/$/, '');
+    const isLocal = domain.includes('localhost') || domain.includes('127.0.0.1');
+    return `${isLocal ? 'http' : 'https'}://${domain}`;
+};
+const fetchJson = async (url) => {
+    const response = await fetch(url);
+    if (!response.ok)
+        throw new Error(`Request to ${url} failed (${response.status} ${response.statusText})`);
+    return (await response.json());
+};
+export default class Init extends Command {
+    static args = {
+        domain: Args.string({ description: 'DocStar docs domain, e.g. docs.msg91.com or localhost:3000', required: true }),
+    };
+    static description = 'Discover published modules for a DocStar docs site, pick which ones to install, and register their CLI commands';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> docs.msg91.com',
+        '<%= config.bin %> <%= command.id %> localhost:3000 --collectionId paM4R4A26Hvb',
+    ];
+    static flags = {
+        collectionId: Flags.string({ description: 'Collection id (required when the domain is not a custom domain, e.g. localhost)' }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(Init);
+        const baseUrl = buildBaseUrl(args.domain);
+        const listUrl = new URL('/p/module.json', baseUrl);
+        if (flags.collectionId)
+            listUrl.searchParams.set('collectionId', flags.collectionId);
+        this.log(`Fetching modules from ${listUrl.toString()} ...`);
+        const listResponse = await fetchJson(listUrl.toString());
+        if (!listResponse.modules || listResponse.modules.length === 0) {
+            this.log('No published modules found.');
+            return;
+        }
+        const selectedPaths = await checkbox({
+            choices: listResponse.modules.map((module) => ({ checked: true, name: `${module.name} (${module.path})`, value: module.path })),
+            message: 'Select modules to install (space to toggle, enter to confirm)',
+        });
+        if (selectedPaths.length === 0) {
+            this.log('No modules selected, nothing installed.');
+            return;
+        }
+        await mkdir(configDir(), { recursive: true });
+        const selectedModules = [];
+        for (const path of selectedPaths) {
+            const moduleUrl = new URL(`/p/${path}/module.json`, baseUrl);
+            if (flags.collectionId)
+                moduleUrl.searchParams.set('collectionId', flags.collectionId);
+            this.log(`Fetching ${path} ...`);
+            const moduleJson = await fetchJson(moduleUrl.toString());
+            await mkdir(configDir() + '/modules', { recursive: true });
+            await writeFile(modulePath(path), JSON.stringify(moduleJson, null, 2));
+            for (const endpoint of moduleJson.endpoints) {
+                const filePath = await generateCommandFile(this.config.root, path, endpoint);
+                this.log(`  registered command: ${this.config.bin} ${path} ${endpoint.cli.command.name} -> ${filePath}`);
+            }
+            await generateListCommandFile(this.config.root, path);
+            this.log(`  registered command: ${this.config.bin} ${path} list`);
+            selectedModules.push({ name: moduleJson.module.name, path });
+        }
+        const savedConfig = {
+            baseUrl,
+            collection: listResponse.collection ?? null,
+            collectionId: flags.collectionId ?? null,
+            domain: args.domain,
+            modules: selectedModules,
+            updatedAt: new Date().toISOString(),
+        };
+        await writeFile(configPath(), JSON.stringify(savedConfig, null, 2));
+        this.log(`\nInstalled ${selectedModules.length} module(s). Config saved to ${configPath()}`);
+    }
+}

package/dist/commands/slack/list.js

@@ -0,0 +1,20 @@
+import {Command} from '@oclif/core'
+import {loadModule} from '../../lib/http.js'
+
+export default class GeneratedList extends Command {
+  static description = 'List installed APIs for the slack module'
+
+  async run() {
+    const moduleJson = await loadModule('slack')
+
+    for (const endpoint of moduleJson.endpoints) {
+      const {cli} = endpoint
+      this.log(`${cli.command.name}${cli.command.aliases.filter((alias) => alias !== cli.command.name).length > 0 ? ` (aliases: ${cli.command.aliases.filter((alias) => alias !== cli.command.name).join(', ')})` : ''}`)
+      if (cli.description) this.log(`  ${cli.description}`)
+      this.log(`  ${endpoint.method}`)
+      if (cli.parameters.required.length > 0) this.log(`  required: ${cli.parameters.required.join(', ')}`)
+      if (cli.parameters.optional.length > 0) this.log(`  optional: ${cli.parameters.optional.join(', ')}`)
+      this.log('')
+    }
+  }
+}

package/dist/commands/slack/send-message-1.js

@@ -0,0 +1,30 @@
+import {Command, Flags} from '@oclif/core'
+import {executeCliCommand} from '../../lib/http.js'
+import {promptForMissingParams} from '../../lib/prompt.js'
+
+const REQUIRED_PARAMS = ["MY_SECRET_KEY"]
+
+export default class Generated extends Command {
+  static description = "send message"
+  static aliases = []
+  static flags = {
+    'MY_SECRET_KEY': Flags.string({description: 'Required parameter'}),
+  }
+
+  async run() {
+    const {flags} = await this.parse(Generated)
+    const params = {}
+    for (const [key, value] of Object.entries(flags)) {
+      if (value !== undefined) params[key] = value
+    }
+
+    Object.assign(params, await promptForMissingParams(REQUIRED_PARAMS, params))
+
+    try {
+      const result = await executeCliCommand('slack', 'send-message-1', params)
+      this.log(JSON.stringify(result, null, 2))
+    } catch (error) {
+      this.error(error.message)
+    }
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/index.js

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/lib/codegen.d.ts

@@ -0,0 +1,3 @@
+import type { EndpointContract } from './types.js';
+export declare const generateCommandFile: (cliRoot: string, modulePathSegment: string, endpoint: EndpointContract) => Promise<string>;
+export declare const generateListCommandFile: (cliRoot: string, modulePathSegment: string) => Promise<string>;

package/dist/lib/codegen.js

@@ -0,0 +1,78 @@
+import { mkdir, writeFile } from 'node:fs/promises';
+import { join } from 'node:path';
+const flagLine = (name, required) => 
+// Required params are collected interactively when missing, so the flag itself stays optional to oclif.
+`    '${name}': Flags.string({description: '${required ? 'Required' : 'Optional'} parameter'}),`;
+const commandFileContent = (modulePathSegment, endpoint) => {
+    const { cli } = endpoint;
+    const flagLines = [
+        ...cli.parameters.required.map((name) => flagLine(name, true)),
+        ...cli.parameters.optional.map((name) => flagLine(name, false)),
+    ].join('\n');
+    return `import {Command, Flags} from '@oclif/core'
+import {executeCliCommand} from '../../lib/http.js'
+import {promptForMissingParams} from '../../lib/prompt.js'
+
+const REQUIRED_PARAMS = ${JSON.stringify(cli.parameters.required)}
+
+export default class Generated extends Command {
+  static description = ${JSON.stringify(cli.description || `${cli.name} (${modulePathSegment})`)}
+  static aliases = ${JSON.stringify(cli.command.aliases.filter((alias) => alias !== cli.name))}
+  static flags = {
+${flagLines}
+  }
+
+  async run() {
+    const {flags} = await this.parse(Generated)
+    const params = {}
+    for (const [key, value] of Object.entries(flags)) {
+      if (value !== undefined) params[key] = value
+    }
+
+    Object.assign(params, await promptForMissingParams(REQUIRED_PARAMS, params))
+
+    try {
+      const result = await executeCliCommand('${modulePathSegment}', '${cli.command.name}', params)
+      this.log(JSON.stringify(result, null, 2))
+    } catch (error) {
+      this.error(error.message)
+    }
+  }
+}
+`;
+};
+const listCommandFileContent = (modulePathSegment) => `import {Command} from '@oclif/core'
+import {loadModule} from '../../lib/http.js'
+
+export default class GeneratedList extends Command {
+  static description = 'List installed APIs for the ${modulePathSegment} module'
+
+  async run() {
+    const moduleJson = await loadModule('${modulePathSegment}')
+
+    for (const endpoint of moduleJson.endpoints) {
+      const {cli} = endpoint
+      this.log(\`\${cli.command.name}\${cli.command.aliases.filter((alias) => alias !== cli.command.name).length > 0 ? \` (aliases: \${cli.command.aliases.filter((alias) => alias !== cli.command.name).join(', ')})\` : ''}\`)
+      if (cli.description) this.log(\`  \${cli.description}\`)
+      this.log(\`  \${endpoint.method}\`)
+      if (cli.parameters.required.length > 0) this.log(\`  required: \${cli.parameters.required.join(', ')}\`)
+      if (cli.parameters.optional.length > 0) this.log(\`  optional: \${cli.parameters.optional.join(', ')}\`)
+      this.log('')
+    }
+  }
+}
+`;
+export const generateCommandFile = async (cliRoot, modulePathSegment, endpoint) => {
+    const dir = join(cliRoot, 'dist', 'commands', modulePathSegment);
+    await mkdir(dir, { recursive: true });
+    const filePath = join(dir, `${endpoint.cli.command.name}.js`);
+    await writeFile(filePath, commandFileContent(modulePathSegment, endpoint));
+    return filePath;
+};
+export const generateListCommandFile = async (cliRoot, modulePathSegment) => {
+    const dir = join(cliRoot, 'dist', 'commands', modulePathSegment);
+    await mkdir(dir, { recursive: true });
+    const filePath = join(dir, 'list.js');
+    await writeFile(filePath, listCommandFileContent(modulePathSegment));
+    return filePath;
+};

package/dist/lib/http.d.ts

@@ -0,0 +1,8 @@
+import type { EndpointContract, ModuleJson } from './types.js';
+export declare const stripHtml: (value: string | null | undefined) => string;
+export declare const loadModule: (modulePathSegment: string) => Promise<ModuleJson>;
+export declare const findEndpoint: (moduleJson: ModuleJson, commandName: string) => EndpointContract | undefined;
+export declare const executeCliCommand: (modulePathSegment: string, commandName: string, params: Record<string, string>) => Promise<{
+    status: number;
+    body: unknown;
+}>;

package/dist/lib/http.js

@@ -0,0 +1,62 @@
+import { readFile } from 'node:fs/promises';
+import { modulePath } from './paths.js';
+// Endpoint fields come from a rich-text editor and may be wrapped in
+// `<span text-block="true">...</span>`-style markup; unwrap to the raw value.
+export const stripHtml = (value) => (value ?? '').replaceAll(/<[^>]*>/g, '');
+const substitutePlaceholders = (template, params) => Object.entries(params).reduce((result, [key, value]) => result.replaceAll(`:${key}`, value).replaceAll(`{${key}}`, value).replaceAll(`{{${key}}}`, value), template);
+export const loadModule = async (modulePathSegment) => {
+    const raw = await readFile(modulePath(modulePathSegment), 'utf8');
+    return JSON.parse(raw);
+};
+export const findEndpoint = (moduleJson, commandName) => moduleJson.endpoints.find((endpoint) => endpoint.cli.command.name === commandName || endpoint.cli.command.aliases.includes(commandName));
+const buildUrl = (endpoint, params) => {
+    const baseUrl = stripHtml(endpoint.baseUrl);
+    const path = substitutePlaceholders(stripHtml(endpoint.url), params);
+    if (/^https?:\/\//.test(path))
+        return path;
+    return `${baseUrl}${path}`;
+};
+const buildHeaders = (endpoint, params) => {
+    const headers = {};
+    for (const [rawKey, rawValue] of Object.entries(endpoint.headers || {})) {
+        const key = stripHtml(rawKey);
+        const value = stripHtml(rawValue?.value ?? rawValue);
+        headers[key] = params[key] ?? value;
+    }
+    return headers;
+};
+const buildBody = (endpoint, params) => {
+    const rawValue = endpoint.body?.raw?.value;
+    if (endpoint.body?.type !== 'JSON' || !rawValue)
+        return undefined;
+    let parsed;
+    try {
+        parsed = JSON.parse(rawValue);
+    }
+    catch {
+        return rawValue;
+    }
+    for (const [key, value] of Object.entries(params)) {
+        if (key in parsed)
+            parsed[key] = value;
+    }
+    return JSON.stringify(parsed);
+};
+export const executeCliCommand = async (modulePathSegment, commandName, params) => {
+    const moduleJson = await loadModule(modulePathSegment);
+    const endpoint = findEndpoint(moduleJson, commandName);
+    if (!endpoint) {
+        throw new Error(`No endpoint found for command "${commandName}" in module "${modulePathSegment}"`);
+    }
+    const url = buildUrl(endpoint, params);
+    const headers = buildHeaders(endpoint, params);
+    const body = buildBody(endpoint, params);
+    const response = await fetch(url, {
+        body,
+        headers,
+        method: endpoint.method,
+    });
+    const contentType = response.headers.get('content-type') || '';
+    const responseBody = contentType.includes('application/json') ? await response.json() : await response.text();
+    return { body: responseBody, status: response.status };
+};

package/dist/lib/paths.d.ts

@@ -0,0 +1,4 @@
+export declare const configDir: () => string;
+export declare const configPath: () => string;
+export declare const modulesDir: () => string;
+export declare const modulePath: (modulePathSegment: string) => string;

package/dist/lib/paths.js

@@ -0,0 +1,6 @@
+import { homedir } from 'node:os';
+import { join } from 'node:path';
+export const configDir = () => join(homedir(), '.docstar');
+export const configPath = () => join(configDir(), 'config.json');
+export const modulesDir = () => join(configDir(), 'modules');
+export const modulePath = (modulePathSegment) => join(modulesDir(), `${modulePathSegment}.json`);

package/dist/lib/prompt.d.ts

@@ -0,0 +1 @@
+export declare const promptForMissingParams: (required: string[], provided: Record<string, string>) => Promise<Record<string, string>>;

package/dist/lib/prompt.js

@@ -0,0 +1,11 @@
+import { input } from '@inquirer/prompts';
+export const promptForMissingParams = async (required, provided) => {
+    const collected = {};
+    for (const key of required) {
+        if (provided[key] !== undefined)
+            continue;
+        // eslint-disable-next-line no-await-in-loop
+        collected[key] = await input({ message: `Enter value for ${key}` });
+    }
+    return collected;
+};

package/dist/lib/types.d.ts

@@ -0,0 +1,49 @@
+export type CliCommandMeta = {
+    name: string;
+    description: string;
+    command: {
+        name: string;
+        aliases: string[];
+    };
+    version: number;
+    parameters: {
+        required: string[];
+        optional: string[];
+    };
+};
+export type EndpointContract = {
+    cli: CliCommandMeta;
+    method: string;
+    url: string;
+    baseUrl: string | null;
+    headers: Record<string, any>;
+    params: Record<string, any>;
+    pathVariables: Record<string, any>;
+    body: any;
+    authentication: Record<string, any>;
+    description: string;
+    sampleResponse: any;
+};
+export type ModuleJson = {
+    module: {
+        id: string;
+        name: string;
+        version: string;
+    };
+    endpoints: EndpointContract[];
+};
+export type ModuleSummary = {
+    name: string;
+    path: string;
+};
+export type SavedConfig = {
+    baseUrl: string;
+    domain: string;
+    collectionId: string | null;
+    collection: {
+        id: string;
+        name: string;
+    } | null;
+    modules: ModuleSummary[];
+    updatedAt: string;
+};

package/dist/lib/types.js

@@ -0,0 +1 @@
+export {};

package/oclif.manifest.json

@@ -0,0 +1,157 @@
+{
+  "commands": {
+    "init": {
+      "aliases": [],
+      "args": {
+        "domain": {
+          "description": "DocStar docs domain, e.g. docs.msg91.com or localhost:3000",
+          "name": "domain",
+          "required": true
+        }
+      },
+      "description": "Discover published modules for a DocStar docs site, pick which ones to install, and register their CLI commands",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> docs.msg91.com",
+        "<%= config.bin %> <%= command.id %> localhost:3000 --collectionId paM4R4A26Hvb"
+      ],
+      "flags": {
+        "collectionId": {
+          "description": "Collection id (required when the domain is not a custom domain, e.g. localhost)",
+          "name": "collectionId",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "init",
+      "pluginAlias": "docstar-cli",
+      "pluginName": "docstar-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "init.js"
+      ]
+    },
+    "slack:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List installed APIs for the slack module",
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "slack:list",
+      "pluginAlias": "docstar-cli",
+      "pluginName": "docstar-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "slack",
+        "list.js"
+      ]
+    },
+    "slack:send-message-1": {
+      "aliases": [],
+      "args": {},
+      "description": "send message",
+      "flags": {
+        "MY_SECRET_KEY": {
+          "description": "Required parameter",
+          "name": "MY_SECRET_KEY",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "slack:send-message-1",
+      "pluginAlias": "docstar-cli",
+      "pluginName": "docstar-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "slack",
+        "send-message-1.js"
+      ]
+    },
+    "hello": {
+      "aliases": [],
+      "args": {
+        "person": {
+          "description": "Person to say hello to",
+          "name": "person",
+          "required": true
+        }
+      },
+      "description": "Say hello",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> friend --from oclif\nhello friend from oclif! (./src/commands/hello/index.ts)\n"
+      ],
+      "flags": {
+        "from": {
+          "char": "f",
+          "description": "Who is saying hello",
+          "name": "from",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "hello",
+      "pluginAlias": "docstar-cli",
+      "pluginName": "docstar-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "hello",
+        "index.js"
+      ]
+    },
+    "hello:world": {
+      "aliases": [],
+      "args": {},
+      "description": "Say hello world",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>\nhello world! (./src/commands/hello/world.ts)\n"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "hello:world",
+      "pluginAlias": "docstar-cli",
+      "pluginName": "docstar-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "hello",
+        "world.js"
+      ]
+    }
+  },
+  "version": "0.0.0"
+}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "docstar-cli",
+  "description": "A new CLI generated with oclif",
+  "version": "0.0.0",
+  "author": "Swayam Maheshwari",
+  "bin": {
+    "docstar-cli": "./bin/run.js"
+  },
+  "bugs": "https://github.com/swayammaheshwari/docstar-cli/issues",
+  "dependencies": {
+    "@inquirer/prompts": "^8.5.2",
+    "@oclif/core": "^4",
+    "@oclif/plugin-help": "^6",
+    "@oclif/plugin-plugins": "^5"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^1",
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^4",
+    "@types/chai": "^4",
+    "@types/mocha": "^10",
+    "@types/node": "^18",
+    "chai": "^4",
+    "eslint": "^9",
+    "eslint-config-oclif": "^6",
+    "eslint-config-prettier": "^10",
+    "mocha": "^11",
+    "oclif": "^4",
+    "shx": "^0.3.3",
+    "ts-node": "^10",
+    "typescript": "^5"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "./bin",
+    "./dist",
+    "./oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/swayammaheshwari/docstar-cli",
+  "keywords": [
+    "oclif"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "type": "module",
+  "oclif": {
+    "bin": "docstar-cli",
+    "dirname": "docstar-cli",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins"
+    ],
+    "topicSeparator": " ",
+    "topics": {
+      "hello": {
+        "description": "Say hello to the world and others"
+      }
+    }
+  },
+  "repository": "swayammaheshwari/docstar-cli",
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "npm run lint",
+    "prepack": "oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "types": "dist/index.d.ts"
+}