docstar-cli 0.0.0 → 1.0.3

package/README.md

@@ -1,456 +1,109 @@
-docstar-cli
-=================
+# docstar-cli
 
-A new CLI generated with oclif
+A CLI for calling published DocStar API endpoints directly from your terminal, without leaving the shell to read docs. Point it at a DocStar docs site, pick which modules (e.g. "Slack") you want, and it turns each published endpoint into a real command you can run. You can install from multiple docs sites/collections at once — each is kept separate under its own **CLI name**.
 
+## Install
 
-[![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
+```sh
+npm install
+npm run build
+npm link
 ```
 
-## `docstar-cli plugins:inspect PLUGIN...`
+`npm link` puts `docstar-cli` on your PATH. Alternatively, run it without linking via `node ./bin/run.js <command>` from the repo root.
 
-Displays installation properties of a plugin.
+## Quick start
 
-```
-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.
+### 1. Discover and install modules
 
-EXAMPLES
-  $ docstar-cli plugins inspect myplugin
+```sh
+docstar-cli init docs.msg91.com
 ```
 
-_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.
+For a local/non-custom-domain docs site, pass the collection id explicitly:
 
+```sh
+docstar-cli init localhost:3000 --collectionId paM4R4A26Hvb
 ```
-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.
+This fetches the list of published modules for that collection, shows an interactive checklist (all modules pre-checked — press `space` to toggle, `enter` to confirm), and for each selected module:
 
-DESCRIPTION
-  Installs a plugin into docstar-cli.
+- saves its full endpoint contract to `~/.docstar/modules/<cli-name>/<module>.json`
+- registers a real CLI command for every endpoint: `docstar-cli <cli-name> <module> <command>`
 
-  Uses npm to install plugins.
+The **CLI name** comes from the collection's settings (set it under the collection's Domain settings in the docs editor — lowercase letters, numbers, `-` and `_` only; auto-generated from the collection name if not set yet). Running `init` against a different domain/collection adds it alongside any others already installed — nothing gets overwritten.
 
-  Installation of a user-installed plugin will override a core plugin.
+Everything is saved to `~/.docstar/config.json`, grouped by collection.
 
-  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.
+### 2. See what's installed
 
-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
+```sh
+docstar-cli list                    # every installed collection
+docstar-cli list msg91              # modules installed for the "msg91" collection
+docstar-cli list msg91 slack        # Slack's installed endpoints in "msg91"
 ```
 
-_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
+send-message-1
+  send message
+  POST
+  required: message
 ```
 
-_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.
+### 3. Call an endpoint
 
+```sh
+docstar-cli msg91 slack send-message-1 --message "hello from the CLI"
 ```
-USAGE
-  $ docstar-cli plugins unlink [PLUGIN...] [-h] [-v]
-
-ARGUMENTS
-  [PLUGIN...]  plugin to uninstall
 
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
+Or omit required parameters and answer the prompts instead:
 
-DESCRIPTION
-  Removes a plugin from the CLI.
-
-ALIASES
-  $ docstar-cli plugins unlink
-  $ docstar-cli plugins remove
-
-EXAMPLES
-  $ docstar-cli plugins unlink myplugin
+```sh
+docstar-cli msg91 slack send-message-1
+? Enter value for message
 ```
 
-## `docstar-cli plugins update`
+The command prints the response status and body from the actual API call.
 
-Update installed plugins.
-
-```
-USAGE
-  $ docstar-cli plugins update [-h] [-v]
+## Use from an AI client (MCP)
 
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
+`docstar-cli` can run as an [MCP](https://modelcontextprotocol.io) server, turning every installed
+endpoint (across all installed collections) into a proper tool an AI client can call directly — no
+shell access required.
 
-DESCRIPTION
-  Update installed plugins.
+```sh
+docstar-cli mcp
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.87/src/commands/plugins/update.ts)_
+Register it with Claude Code (`.mcp.json`) or Claude Desktop (`claude_desktop_config.json`):
 
-## `docstar-cli slack list`
-
-List installed APIs for the slack module
-
-```
-USAGE
-  $ docstar-cli slack list
-
-DESCRIPTION
-  List installed APIs for the slack module
+```json
+{
+  "mcpServers": {
+    "docstar": {
+      "command": "docstar-cli",
+      "args": ["mcp"]
+    }
+  }
+}
 ```
 
-_See code: [src/commands/slack/list.ts](https://github.com/swayammaheshwari/docstar-cli/blob/v0.0.0/src/commands/slack/list.ts)_
+Each installed endpoint becomes one tool named `<cli-name>__<module>__<command>` (e.g.
+`msg91__slack__send-message-1`), with required/optional parameters exposed in its schema. A prompt
+like "call the slack api and send a message saying hi" resolves directly to that tool call — the
+AI client asks you for any required value it can't infer, exactly like any other MCP tool. Run
+`docstar-cli init` first so there's at least one installed module for `mcp` to expose.
 
-## `docstar-cli slack send-message-1`
+## How it works
 
-send message
+- `docstar-cli init` talks to `GET /p/module.json?collectionId=...` (the collection's name, CLI name, and list of modules) and `GET /p/<module>/module.json?collectionId=...` (a module's endpoint contract) on the docs site.
+- Each endpoint's contract (method, url, base url, headers, body, and CLI parameter names) is saved locally and used to build the real HTTP request when you run its command — no network round-trip to the docs site is needed to run a command once a module is installed.
+- Commands are generated as real files on disk under this repo's `dist/commands/<cli-name>/<module>/`, which is why `npm run build` (it wipes `dist/`) requires re-running `docstar-cli init` for each installed collection afterwards to reinstall your modules.
 
-```
-USAGE
-  $ docstar-cli slack send-message-1 [--MY_SECRET_KEY <value>]
-
-FLAGS
-  --MY_SECRET_KEY=<value>  Required parameter
+## Development
 
-DESCRIPTION
-  send message
+```sh
+npm run build   # compile TypeScript to dist/
+npm run lint    # eslint
+npm test        # mocha
 ```
-
-_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/dist/commands/{slack → api-collection/slack}/send-message-1.js

@@ -1,14 +1,14 @@
 import {Command, Flags} from '@oclif/core'
-import {executeCliCommand} from '../../lib/http.js'
-import {promptForMissingParams} from '../../lib/prompt.js'
+import {executeCliCommand} from '../../../lib/http.js'
+import {promptForMissingParams} from '../../../lib/prompt.js'
 
-const REQUIRED_PARAMS = ["MY_SECRET_KEY"]
+const REQUIRED_PARAMS = ["message"]
 
 export default class Generated extends Command {
   static description = "send message"
   static aliases = []
   static flags = {
-    'MY_SECRET_KEY': Flags.string({description: 'Required parameter'}),
+    'message': Flags.string({description: 'Required parameter'}),
   }
 
   async run() {
@@ -21,7 +21,7 @@ export default class Generated extends Command {
     Object.assign(params, await promptForMissingParams(REQUIRED_PARAMS, params))
 
     try {
-      const result = await executeCliCommand('slack', 'send-message-1', params)
+      const result = await executeCliCommand('api-collection', 'slack', 'send-message-1', params)
       this.log(JSON.stringify(result, null, 2))
     } catch (error) {
       this.error(error.message)

package/dist/commands/api-collection-2/viasocket/send-alert.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 = ["message"]
+
+export default class Generated extends Command {
+  static description = "send alert"
+  static aliases = []
+  static flags = {
+    'message': 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('api-collection-2', 'viasocket', 'send-alert', params)
+      this.log(JSON.stringify(result, null, 2))
+    } catch (error) {
+      this.error(error.message)
+    }
+  }
+}

package/dist/commands/docstar-apis/public-routes/find-matches-1.js

@@ -0,0 +1,33 @@
+import {Command, Flags} from '@oclif/core'
+import {executeCliCommand} from '../../../lib/http.js'
+import {promptForMissingParams} from '../../../lib/prompt.js'
+
+const REQUIRED_PARAMS = ["query","collectionIds","getUrl","allowNonDomain"]
+
+export default class Generated extends Command {
+  static description = "Find matches"
+  static aliases = []
+  static flags = {
+    'query': Flags.string({description: 'Required parameter'}),
+    'collectionIds': Flags.string({description: 'Required parameter'}),
+    'getUrl': Flags.string({description: 'Required parameter'}),
+    'allowNonDomain': 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('docstar-apis', 'public-routes', 'find-matches-1', params)
+      this.log(JSON.stringify(result, null, 2))
+    } catch (error) {
+      this.error(error.message)
+    }
+  }
+}