@doquflow/cli 0.4.4 → 0.4.6

package/dist/commands/init.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildClaudeMd = buildClaudeMd;
+exports.buildAgentsMd = buildAgentsMd;
 exports.run = run;
 const node_fs_1 = __importDefault(require("node:fs"));
 const promises_1 = __importDefault(require("node:fs/promises"));
@@ -29,6 +30,12 @@ function getVSCodeMcpConfigPath() {
     }
     return node_path_1.default.join(node_os_1.default.homedir(), ".config", "Code", "User", "mcp.json");
 }
+function getCopilotCliMcpConfigPath() {
+    return node_path_1.default.join(node_os_1.default.homedir(), ".copilot", "mcp-config.json");
+}
+function getCodexConfigPath() {
+    return node_path_1.default.join(node_os_1.default.homedir(), ".codex", "config.toml");
+}
 function resolveServerBin() {
     // Try npm-installed package first
     try {
@@ -158,9 +165,98 @@ async function writeClaudeMd(projectDir) {
         await promises_1.default.writeFile(claudeMdPath, newSection, "utf8");
     }
 }
+function buildAgentsMd(projectDir) {
+    return `# DocuFlow — AI Documentation Assistant
+
+DocuFlow is an MCP server that provides structured access to this codebase and maintains a living wiki.
+It is registered via \`.codex/config.toml\` and available as MCP tools in every Codex session.
+
+## Available MCP Tools
+
+### Codebase Scanner
+- **read_module** — Analyse a single file: language, classes, functions, dependencies, DB tables, endpoints, config refs, raw content.
+  - \`read_module({ path: "src/UserService.cs" })\`
+- **list_modules** — Walk a directory, extract facts for every file. One call to understand the whole project.
+  - \`list_modules({ path: "${projectDir}" })\`
+- **write_spec** — Save a markdown spec to \`.docuflow/specs/<name>.md\`.
+  - \`write_spec({ project_path: "${projectDir}", filename: "UserService", content: "..." })\`
+- **read_specs** — Read saved specs, optionally filtered by name.
+  - \`read_specs({ project_path: "${projectDir}" })\`
+
+### Wiki Pipeline
+- **ingest_source** — Ingest a markdown file from \`.docuflow/sources/\` into the wiki (entities, concepts).
+- **update_index** — Rebuild \`.docuflow/index.md\` from all wiki pages.
+- **list_wiki** — List all wiki pages by category (entity/concept/timeline/synthesis).
+- **wiki_search** — BM25 search across all wiki pages.
+- **query_wiki** — Q&A: searches wiki, synthesises an answer, returns citations.
+  - \`query_wiki({ project_path: "${projectDir}", question: "How does auth work?" })\`
+- **synthesize_answer** — Generate a markdown synthesis from a list of page IDs.
+- **save_answer_as_page** — Persist a synthesis as a wiki page.
+
+### Health & Guidance
+- **lint_wiki** — Health check: orphan pages, broken refs, stale content. Returns a 0–100 health score.
+- **get_schema_guidance** — Recommend what wiki pages should exist based on schema + current state.
+- **preview_generation** — Preview what a tool will generate before running it.
+
+## Common Workflows
+
+Start here — understand the codebase:
+\`\`\`
+list_modules({ path: "${projectDir}" })
+→ write_spec for important modules
+\`\`\`
+
+Answer a question:
+\`\`\`
+query_wiki({ project_path: "${projectDir}", question: "..." })
+\`\`\`
+
+Maintain wiki health:
+\`\`\`
+lint_wiki({ project_path: "${projectDir}" })
+\`\`\`
+
+## Storage Layout
+
+\`\`\`
+.docuflow/
+├── specs/        Code specs written by write_spec
+├── wiki/         LLM-generated wiki pages
+│   ├── entities/
+│   ├── concepts/
+│   ├── timelines/
+│   └── syntheses/
+├── sources/      Raw markdown docs to ingest
+├── schema.md     Wiki configuration (edit to customise)
+├── index.md      Auto-maintained catalog
+└── log.md        Operation log
+\`\`\`
+`;
+}
+async function writeAgentsMd(projectDir) {
+    const agentsMdPath = node_path_1.default.join(projectDir, "AGENTS.md");
+    const newSection = buildAgentsMd(projectDir);
+    if (node_fs_1.default.existsSync(agentsMdPath)) {
+        const existing = await promises_1.default.readFile(agentsMdPath, "utf8");
+        if (existing.includes("DocuFlow")) {
+            // Replace existing DocuFlow section
+            const withoutDocuflow = existing.replace(/\n?# DocuFlow[\s\S]*/, "").trimEnd();
+            await promises_1.default.writeFile(agentsMdPath, withoutDocuflow + "\n\n" + newSection, "utf8");
+        }
+        else {
+            // Append to existing AGENTS.md
+            await promises_1.default.appendFile(agentsMdPath, "\n\n" + newSection, "utf8");
+        }
+    }
+    else {
+        await promises_1.default.writeFile(agentsMdPath, newSection, "utf8");
+    }
+}
 async function run() {
     const configPath = getClaudeDesktopConfigPath();
     const vscodeConfigPath = getVSCodeMcpConfigPath();
+    const copilotCliConfigPath = getCopilotCliMcpConfigPath();
+    const codexConfigPath = getCodexConfigPath();
     const serverBin = resolveServerBin();
     const nodeBin = process.execPath;
     // Register in Claude Desktop config
@@ -198,6 +294,45 @@ async function run() {
     catch {
         // VS Code not installed or config dir not writable — skip silently
     }
+    // Register in GitHub Copilot CLI MCP config (~/.copilot/mcp-config.json)
+    let copilotCliRegistered = false;
+    let copilotCliConfig = {};
+    try {
+        const raw = await promises_1.default.readFile(copilotCliConfigPath, "utf8");
+        copilotCliConfig = JSON.parse(raw);
+    }
+    catch {
+        // File may not exist yet
+    }
+    if (!copilotCliConfig.mcpServers)
+        copilotCliConfig.mcpServers = {};
+    copilotCliConfig.mcpServers.docuflow = { type: "local", command: nodeBin, args: [serverBin], tools: ["*"] };
+    try {
+        await promises_1.default.mkdir(node_path_1.default.dirname(copilotCliConfigPath), { recursive: true });
+        await promises_1.default.writeFile(copilotCliConfigPath, JSON.stringify(copilotCliConfig, null, 2) + "\n", "utf8");
+        copilotCliRegistered = true;
+    }
+    catch {
+        // Copilot CLI not installed — skip silently
+    }
+    // Register in OpenAI Codex CLI (~/.codex/config.toml in TOML format)
+    let codexCliRegistered = false;
+    try {
+        await promises_1.default.mkdir(node_path_1.default.dirname(codexConfigPath), { recursive: true });
+        let tomlContent = "";
+        try {
+            tomlContent = await promises_1.default.readFile(codexConfigPath, "utf8");
+        }
+        catch { /* new file */ }
+        if (!tomlContent.includes("[mcp_servers.docuflow]")) {
+            const entry = `\n[mcp_servers.docuflow]\ncommand = "${nodeBin}"\nargs = [${JSON.stringify(serverBin)}]\n`;
+            await promises_1.default.writeFile(codexConfigPath, tomlContent + entry, "utf8");
+        }
+        codexCliRegistered = true;
+    }
+    catch {
+        // Codex CLI not installed — skip silently
+    }
     // Create .docuflow/ directory structure
     const projectDir = process.cwd();
     const docuflowDir = node_path_1.default.join(projectDir, ".docuflow");
@@ -220,6 +355,29 @@ async function run() {
     await copyTemplateFile("log.md", node_path_1.default.join(docuflowDir, "log.md"));
     // Generate CLAUDE.md so Claude Code picks up DocuFlow automatically
     await writeClaudeMd(projectDir);
+    // Generate AGENTS.md so OpenAI Codex picks up DocuFlow automatically
+    await writeAgentsMd(projectDir);
+    // Write .vscode/mcp.json for project-level workspace MCP config (shareable via git)
+    // Uses npx so it works on any machine — safe to commit
+    const vscodeDirPath = node_path_1.default.join(projectDir, ".vscode");
+    const vscodeWorkspaceMcpPath = node_path_1.default.join(vscodeDirPath, "mcp.json");
+    let workspaceMcpConfig = {};
+    try {
+        const raw = await promises_1.default.readFile(vscodeWorkspaceMcpPath, "utf8");
+        workspaceMcpConfig = JSON.parse(raw);
+    }
+    catch {
+        // File doesn't exist yet
+    }
+    if (!workspaceMcpConfig.servers)
+        workspaceMcpConfig.servers = {};
+    workspaceMcpConfig.servers.docuflow = {
+        command: "npx",
+        args: ["-y", "-p", "@doquflow/server", "docuflow-server"],
+        type: "stdio",
+    };
+    await promises_1.default.mkdir(vscodeDirPath, { recursive: true });
+    await promises_1.default.writeFile(vscodeWorkspaceMcpPath, JSON.stringify(workspaceMcpConfig, null, 2) + "\n", "utf8");
     // Add .docuflow/ to .gitignore if present and not already listed
     const gitignorePath = node_path_1.default.join(process.cwd(), ".gitignore");
     if (node_fs_1.default.existsSync(gitignorePath)) {
@@ -228,32 +386,34 @@ async function run() {
             await promises_1.default.appendFile(gitignorePath, "\n# Docuflow\n.docuflow/\n");
         }
     }
-    console.log("✓ Docuflow initialised successfully.");
+    console.log("\u2713 DocuFlow initialised successfully.");
     console.log("");
-    console.log("📁 Structure created:");
+    console.log("\ud83d\udcc1 Structure created:");
     console.log(`  ${docuflowDir}/`);
-    console.log(`  ├── specs/              (for legacy specs)`);
-    console.log(`  ├── wiki/               (LLM-generated pages)`);
-    console.log(`  │   ├── entities/`);
-    console.log(`  │   ├── concepts/`);
-    console.log(`  │   ├── timelines/`);
-    console.log(`  │   └── syntheses/`);
-    console.log(`  ├── sources/            (immutable raw files)`);
-    console.log(`  ├── schema.md           (wiki configuration)`);
-    console.log(`  ├── index.md            (auto-maintained catalog)`);
-    console.log(`  └── log.md              (operation log)`);
+    console.log(`  \u251c\u2500\u2500 specs/              (code specs written by the agent)`);
+    console.log(`  \u251c\u2500\u2500 wiki/               (LLM-generated wiki pages)`);
+    console.log(`  \u2502   \u251c\u2500\u2500 entities/`);
+    console.log(`  \u2502   \u251c\u2500\u2500 concepts/`);
+    console.log(`  \u2502   \u251c\u2500\u2500 timelines/`);
+    console.log(`  \u2502   \u2514\u2500\u2500 syntheses/`);
+    console.log(`  \u251c\u2500\u2500 sources/            (raw markdown documents to ingest)`);
+    console.log(`  \u251c\u2500\u2500 schema.md           (wiki configuration)`);
+    console.log(`  \u251c\u2500\u2500 index.md            (auto-maintained catalog)`);
+    console.log(`  \u2514\u2500\u2500 log.md              (operation log)`);
     console.log("");
-    console.log("📝 CLAUDE.md:");
-    console.log(`  Generated at: ${node_path_1.default.join(projectDir, "CLAUDE.md")}`);
-    console.log(`  Claude Code will automatically read DocuFlow tool instructions.`);
+    console.log("\ud83d\udcdd Instruction files:");
+    console.log(`  CLAUDE.md  ✓ ${node_path_1.default.join(projectDir, "CLAUDE.md")}`);
+    console.log(`  AGENTS.md  ✓ ${node_path_1.default.join(projectDir, "AGENTS.md")}`);
     console.log("");
-    console.log("🔧 MCP Configuration:");
-    console.log(`  Claude Desktop: ✓ registered`);
-    console.log(`  GitHub Copilot: ${vscodeRegistered ? "✓ registered" : "— VS Code not detected (add manually to .vscode/mcp.json)"}`);
+    console.log("\ud83d\udd27 MCP Registration:");
+    console.log(`  Claude Desktop:  \u2713 registered`);
+    console.log(`  VS Code Copilot: ${vscodeRegistered ? "\u2713 registered (user-level)" : "\u2014 not detected"}`);
+    console.log(`  Copilot CLI:     ${copilotCliRegistered ? "\u2713 registered (~/.copilot/mcp-config.json)" : "\u2014 not detected"}`);
+    console.log(`  Codex CLI:       ${codexCliRegistered ? "\u2713 registered (~/.codex/config.toml)" : "\u2014 not detected"}`);
+    console.log(`  Workspace:       \u2713 .vscode/mcp.json written (commit to share with team)`);
     console.log("");
-    console.log("📖 Next steps:");
-    console.log("  1. Edit .docuflow/schema.md to customize your wiki");
-    console.log("  2. Add source files to .docuflow/sources/");
-    console.log("  3. Use DocuFlow tools to ingest, query, and maintain wiki");
-    console.log("  4. Restart Claude Desktop / reload VS Code window to activate");
+    console.log("\ud83d\udcd6 Next steps:");
+    console.log("  1. Edit .docuflow/schema.md to customize your wiki domain");
+    console.log("  2. Add markdown docs to .docuflow/sources/ then ingest them");
+    console.log("  3. Restart Claude Desktop / reload VS Code / restart Copilot CLI");
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doquflow/cli",
-  "version": "0.4.4",
+  "version": "0.4.6",
   "description": "CLI for setting up Docuflow in your project",
   "author": "Docuflow <hello@doquflows.dev>",
   "license": "MIT",
@@ -30,7 +30,7 @@
     "build": "tsc"
   },
   "dependencies": {
-    "@doquflow/server": "0.4.4"
+    "@doquflow/server": "0.4.6"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",