docstar-cli 1.3.1 → 1.4.0

package/README.md

@@ -1,12 +1,12 @@
 # docstar-cli
 
-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**.
+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 **slug**.
 
 ## Concepts: collection → module → endpoint
 
 Every command follows a fixed three-level hierarchy:
 
-1. **Collection** — a docs site, identified by its **CLI name** (e.g. `msg91`). This is what `docstar-cli init` installs.
+1. **Collection** — a docs site, identified by its **slug** (e.g. `msg91`). This is what `docstar-cli init` installs.
 2. **Module** — a top-level section within that collection (e.g. `slack`).
 3. **Endpoint** — one published API within a module, turned into a command (e.g. `send-message-1`).
 
@@ -38,10 +38,10 @@ docstar-cli init localhost:3000 --collectionId paM4R4A26Hvb
 
 This fetches the list of published modules for that collection and shows an interactive checklist (nothing checked by default — press `space` to toggle a module, or select the **"Select all modules"** entry at the bottom of the list to install everything, then `enter` to confirm). For each selected module it:
 
-- 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>`
+- saves its full endpoint contract to `~/.docstar/modules/<slug>/<module>.json`
+- registers a real CLI command for every endpoint: `docstar-cli <slug> <module> <command>`
 
-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.
+The **slug** is chosen when the collection is created in DocStar (lowercase letters, numbers, `-` and `_` only) and never changes afterwards; the same slug identifies the collection for MCP. Running `init` against a different domain/collection adds it alongside any others already installed — nothing gets overwritten.
 
 Everything is saved to `~/.docstar/config.json`, grouped by collection.
 
@@ -128,9 +128,9 @@ there's at least one installed module for `mcp` to expose.
 
 ## How it works
 
-- `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.
+- `docstar-cli init` talks to `GET /p/module.json?collectionId=...` (the collection's name, slug, 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.
+- Commands are generated as real files on disk under this repo's `dist/commands/<slug>/<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.
 
 ## Development
 

package/dist/commands/dump-test/parent-page/collection.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 = ["username","password","this is a"]
+
+export default class Generated extends Command {
+  static description = "this is the collection for api testing"
+  static aliases = []
+  static flags = {
+    "username": Flags.string({description: "Required parameter"}),
+    "password": Flags.string({description: "Required parameter"}),
+    "this is a": Flags.string({description: "Required parameter"}),
+    "content-type": Flags.string({description: 'Header value'}),
+  }
+
+  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("dump-test", "parent-page", "collection", params)
+      this.log(JSON.stringify(result, null, 2))
+    } catch (error) {
+      this.error(error.message)
+    }
+  }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docstar-cli",
   "description": "Call published DocStar API endpoints directly from your terminal, or expose them as MCP tools for AI clients.",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "author": "Swayam Maheshwari",
   "bin": {
     "docstar-cli": "./bin/run.js"
@@ -27,7 +27,6 @@
     "eslint-config-prettier": "^10",
     "mocha": "^11",
     "oclif": "^4",
-    "shx": "^0.3.3",
     "ts-node": "^10",
     "typescript": "^5"
   },
@@ -36,8 +35,7 @@
   },
   "files": [
     "./bin",
-    "./dist",
-    "./oclif.manifest.json"
+    "./dist"
   ],
   "homepage": "https://github.com/swayammaheshwari/docstar-cli",
   "keywords": [
@@ -59,9 +57,8 @@
   "scripts": {
     "build": "tsc -b",
     "lint": "eslint",
-    "postpack": "shx rm -f oclif.manifest.json",
     "posttest": "npm run lint",
-    "prepack": "oclif manifest && oclif readme",
+    "prepack": "oclif readme",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "version": "oclif readme && git add README.md"
   },