@remcp/docsy-cli 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Anton Baider
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,25 @@
-# Temporary Holding Version
+# @remcp/docsy-cli
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Command-line client for the Docsy public documentation API and MCP setup.
+
+## Install
+
+```sh
+npm install --global @remcp/docsy-cli
+```
+
+## Use
+
+```sh
+docsy library react
+docsy search "effect cleanup" --library react
+docsy docs /reactjs/react.dev "useEffect cleanup"
+docsy setup --claude
+docsy mcp
+```
+
+For one-off use, run `npx @remcp/docsy-cli --help`.
+
+The `@remcp/docsy-cli` package depends on the same-version `@remcp/docsy-sdk` package; the SDK must be published first. Anonymous queries are limited to public documentation. MIT License, copyright Anton Baider.
+
+Documentation: https://docsy.remcp.site/docs

package/dist/index.js

@@ -0,0 +1,152 @@
+#!/usr/bin/env node
+import { Docsy } from "@remcp/docsy-sdk";
+import { setup } from "./setup.js";
+const args = process.argv.slice(2);
+const command = args.shift();
+const value = (flag) => { const i = args.indexOf(flag); return i >= 0 ? args[i + 1] : undefined; };
+const values = (flag) => args.flatMap((item, index) => item === flag && args[index + 1] ? [args[index + 1]] : []);
+const has = (flag) => args.includes(flag);
+const baseUrl = value("--base-url") ?? process.env.DOCSY_BASE_URL ?? "https://docsy.remcp.site";
+const apiKey = value("--api-key") ?? process.env.DOCSY_API_KEY;
+const client = new Docsy({ baseUrl, apiKey, headers: { "x-docsy-client": "cli" } });
+function help() {
+    console.log([
+        "Docsy — current documentation for AI coding agents",
+        "",
+        "Usage:",
+        "  docsy library <name> [query] [--json]",
+        "  docsy docs <libraryId> <query> [--fast] [--json]",
+        "  docsy search <query> [--library NAME] [--version VERSION] [--language LANGUAGE] [--json]",
+        "  docsy refresh <libraryId> [--branch BRANCH]",
+        "  docsy metrics <libraryId> [--days N]",
+        "  docsy policies [--patch-json JSON]",
+        "  docsy add github <repositoryUrl>",
+        "  docsy add gitlab <repositoryUrl>",
+        "  docsy add bitbucket <repositoryUrl>",
+        "  docsy add git <repositoryUrl>",
+        "  docsy add website <url> [--base-url-scope URL]",
+        "  docsy add llmstxt <url>",
+        "  docsy add openapi <url>",
+        "  docsy setup --cursor|--claude|--codex|--vscode|--gemini|--opencode|--copilot [--project] [--api-key KEY]",
+        "  docsy mcp",
+        "",
+        "Options:",
+        "  --base-url URL   Docsy deployment root",
+        "  --api-key KEY    Personal docsy_ API key",
+        "  --json           JSON output",
+        "  --project        Configure current project instead of global client config"
+    ].join("\n"));
+}
+async function main() {
+    if (!command || command === "help" || has("--help")) {
+        help();
+        return;
+    }
+    if (command === "mcp") {
+        console.log(baseUrl.replace(/\/$/, "") + "/mcp");
+        return;
+    }
+    if (command === "library") {
+        const name = args[0];
+        if (!name)
+            throw new Error("library name is required");
+        const query = args[1] && !args[1].startsWith("--") ? args[1] : name;
+        const results = await client.searchLibrary(query, name);
+        if (has("--json")) {
+            console.log(JSON.stringify(results, null, 2));
+            return;
+        }
+        if (!results.length) {
+            console.log("No matching libraries.");
+            return;
+        }
+        for (let i = 0; i < results.length; i++) {
+            const x = results[i];
+            console.log((i + 1) + ". " + x.name + "\n   Library ID: " + x.libraryId + "\n   " + x.description + "\n   Code Snippets: " + x.codeSnippets + "\n   Versions: " + (x.versions.join(", ") || "none") + "\n");
+        }
+        return;
+    }
+    if (command === "docs") {
+        const libraryId = args[0], query = args[1];
+        if (!libraryId || !query)
+            throw new Error("docs requires <libraryId> <query>");
+        const result = await client.getContext(query, libraryId, { type: has("--json") ? "json" : "txt", fast: has("--fast") });
+        console.log(typeof result === "string" ? result : JSON.stringify(result, null, 2));
+        return;
+    }
+    if (command === "search") {
+        const query = args[0];
+        if (!query)
+            throw new Error("search query is required");
+        const libraries = values("--library");
+        const result = await client.search(query, {
+            type: has("--json") ? "json" : "txt",
+            ...(libraries.length ? { library: libraries } : {}),
+            ...(value("--version") ? { version: value("--version") } : {}),
+            ...(value("--language") ? { language: value("--language") } : {})
+        });
+        console.log(typeof result === "string" ? result : JSON.stringify(result, null, 2));
+        return;
+    }
+    if (command === "refresh") {
+        const libraryId = args[0];
+        if (!libraryId)
+            throw new Error("refresh requires <libraryId>");
+        const result = await client.refreshLibrary(libraryId, { ...(value("--branch") ? { branch: value("--branch") } : {}) });
+        console.log(has("--json") ? JSON.stringify(result, null, 2) : result.message);
+        return;
+    }
+    if (command === "metrics") {
+        const libraryId = args[0];
+        if (!libraryId)
+            throw new Error("metrics requires <libraryId>");
+        const daysRaw = value("--days");
+        const days = daysRaw ? Number(daysRaw) : 30;
+        if (!Number.isInteger(days) || days < 1 || days > 365)
+            throw new Error("--days must be an integer between 1 and 365");
+        const result = await client.getLibraryMetrics(libraryId, days);
+        console.log(JSON.stringify(result, null, 2));
+        return;
+    }
+    if (command === "policies") {
+        const patch = value("--patch-json");
+        const result = patch
+            ? await client.updatePolicies(JSON.parse(patch))
+            : await client.getPolicies();
+        console.log(JSON.stringify(result, null, 2));
+        return;
+    }
+    if (command === "add") {
+        const kind = args[0], sourceUrl = args[1];
+        if (!kind || !sourceUrl)
+            throw new Error("add requires <github|gitlab|bitbucket|git|website|llmstxt|openapi> <url>");
+        const result = kind === "github"
+            ? await client.addGitHubRepository(sourceUrl)
+            : kind === "gitlab"
+                ? await client.addGitLabRepository(sourceUrl)
+                : kind === "bitbucket"
+                    ? await client.addBitbucketRepository(sourceUrl)
+                    : kind === "git"
+                        ? await client.addGitRepository(sourceUrl)
+                        : kind === "website"
+                            ? await client.addWebsite(sourceUrl, { ...(value("--base-url-scope") ? { websiteBaseUrl: value("--base-url-scope") } : {}) })
+                            : kind === "llmstxt"
+                                ? await client.addLlmsTxt(sourceUrl)
+                                : kind === "openapi"
+                                    ? await client.addOpenApi(sourceUrl)
+                                    : (() => { throw new Error("Unknown source type: " + kind); })();
+        console.log(has("--json") ? JSON.stringify(result, null, 2) : result.message + "\nLibrary ID: " + result.libraryName);
+        return;
+    }
+    if (command === "setup") {
+        const agents = ["cursor", "claude", "codex", "vscode", "gemini", "opencode", "copilot"];
+        const agent = agents.find(a => has("--" + a));
+        if (!agent)
+            throw new Error("Choose --cursor, --claude, --codex, --vscode, --gemini, --opencode or --copilot");
+        const result = await setup(agent, has("--project") ? "project" : "global", baseUrl, apiKey);
+        console.log("Configured Docsy for " + agent + ".\nMCP: " + result.mcpUrl + "\nConfig: " + result.configPath + "\nRule: " + result.rulePath);
+        return;
+    }
+    throw new Error("Unknown command: " + command);
+}
+main().catch(error => { console.error(error instanceof Error ? error.message : String(error)); process.exitCode = 1; });

package/dist/setup.js

@@ -0,0 +1,109 @@
+import { homedir } from "node:os";
+import { dirname, join } from "node:path";
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+const RULE = [
+    "# Docsy documentation rule",
+    "",
+    "Use Docsy whenever library, framework, SDK, API, CLI, or cloud-service documentation could affect correctness.",
+    "Resolve the library ID before querying documentation unless an exact /org/project[/version] ID is already known.",
+    "Prefer version-specific documentation and preserve source URLs when answering.",
+    ""
+].join("\n");
+async function readJson(path) {
+    try {
+        return JSON.parse(await readFile(path, "utf8"));
+    }
+    catch {
+        return {};
+    }
+}
+async function writeJson(path, value) {
+    await mkdir(dirname(path), { recursive: true });
+    await writeFile(path, JSON.stringify(value, null, 2) + "\n");
+}
+function mergeSection(config, key, entry) {
+    const section = (config[key] && typeof config[key] === "object" ? config[key] : {});
+    return { ...config, [key]: { ...section, docsy: entry } };
+}
+function httpEntry(url, apiKey, type) {
+    return { ...(type ? { type } : {}), url, ...(apiKey ? { headers: { Authorization: "Bearer " + apiKey } } : {}) };
+}
+function home(...parts) { return join(homedir(), ...parts); }
+async function installRule(agent, scope) {
+    const cwd = process.cwd();
+    let path;
+    let prefix = "";
+    switch (agent) {
+        case "cursor":
+            path = scope === "global" ? home(".cursor", "rules", "docsy.mdc") : join(cwd, ".cursor", "rules", "docsy.mdc");
+            prefix = "---\nalwaysApply: true\n---\n\n";
+            break;
+        case "claude":
+            path = scope === "global" ? home(".claude", "rules", "docsy.md") : join(cwd, ".claude", "rules", "docsy.md");
+            break;
+        case "vscode":
+            path = scope === "global" ? home(".config", "Code", "User", "prompts", "docsy.instructions.md") : join(cwd, ".github", "instructions", "docsy.instructions.md");
+            prefix = '---\napplyTo: "**"\n---\n\n';
+            break;
+        default:
+            path = scope === "global" ? home(".agents", "skills", "docsy", "SKILL.md") : join(cwd, ".agents", "skills", "docsy", "SKILL.md");
+            break;
+    }
+    await mkdir(dirname(path), { recursive: true });
+    await writeFile(path, prefix + RULE);
+    return path;
+}
+export async function setup(agent, scope, baseUrl, apiKey) {
+    const cwd = process.cwd();
+    const mcpUrl = baseUrl.replace(/\/$/, "") + "/mcp";
+    let path;
+    if (agent === "codex") {
+        path = scope === "global" ? home(".codex", "config.toml") : join(cwd, ".codex", "config.toml");
+        let existing = "";
+        try {
+            existing = await readFile(path, "utf8");
+        }
+        catch { }
+        const marker = "# --- docsy managed ---";
+        const lines = [marker, "[mcp_servers.docsy]", "url = " + JSON.stringify(mcpUrl)];
+        if (apiKey)
+            lines.push("", "[mcp_servers.docsy.http_headers]", "Authorization = " + JSON.stringify("Bearer " + apiKey));
+        lines.push(marker);
+        const block = lines.join("\n");
+        const start = existing.indexOf(marker);
+        let next;
+        if (start >= 0) {
+            const end = existing.indexOf(marker, start + marker.length);
+            next = end >= 0 ? existing.slice(0, start) + block + existing.slice(end + marker.length) : existing + "\n" + block + "\n";
+        }
+        else
+            next = existing.replace(/\s*$/, "") + "\n\n" + block + "\n";
+        await mkdir(dirname(path), { recursive: true });
+        await writeFile(path, next);
+    }
+    else {
+        const specs = {
+            claude: { project: ".mcp.json", global: home(".claude.json"), key: "mcpServers", type: "http" },
+            cursor: { project: join(".cursor", "mcp.json"), global: home(".cursor", "mcp.json"), key: "mcpServers" },
+            vscode: { project: join(".vscode", "mcp.json"), global: home(".config", "Code", "User", "mcp.json"), key: "servers", type: "http" },
+            gemini: { project: join(".gemini", "settings.json"), global: home(".gemini", "settings.json"), key: "mcpServers", urlKey: "httpUrl" },
+            opencode: { project: "opencode.json", global: home(".config", "opencode", "opencode.json"), key: "mcp", type: "remote" },
+            copilot: { project: ".mcp.json", global: home(".copilot", "mcp-config.json"), key: "mcpServers", type: "http" }
+        };
+        const spec = specs[agent];
+        path = scope === "global" ? spec.global : join(cwd, spec.project);
+        const cfg = await readJson(path);
+        let e = httpEntry(mcpUrl, apiKey, "type" in spec ? spec.type : undefined);
+        if ("urlKey" in spec && spec.urlKey === "httpUrl") {
+            const { url, ...rest } = e;
+            e = { ...rest, httpUrl: url };
+        }
+        if (agent === "opencode")
+            e = { ...e, enabled: true };
+        if (agent === "copilot")
+            e = { ...e, tools: ["*"] };
+        await writeJson(path, mergeSection(cfg, spec.key, e));
+    }
+    const rulePath = await installRule(agent, scope);
+    return { configPath: path, rulePath, mcpUrl };
+}

package/package.json

@@ -1,6 +1,40 @@
 {
   "name": "@remcp/docsy-cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Docsy CLI for current documentation and MCP setup",
+  "type": "module",
+  "bin": {
+    "docsy": "./dist/index.js"
+  },
+  "main": "./dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "lint": "eslint src test --ext .ts,.tsx,.js,.mjs"
+  },
+  "dependencies": {
+    "@remcp/docsy-sdk": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.0",
+    "typescript": "^5.9.2",
+    "vitest": "^4.0.4"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/antonbaider/docsy.git",
+    "directory": "packages/cli"
+  },
+  "homepage": "https://docsy.remcp.site/",
+  "bugs": {
+    "url": "https://github.com/antonbaider/docsy/issues"
+  }
+}