@doquflow/cli 0.1.1 → 0.3.0

package/dist/commands/init-interactive.js

@@ -0,0 +1,327 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runInteractive = runInteractive;
+const promises_1 = __importDefault(require("node:fs/promises"));
+const node_path_1 = __importDefault(require("node:path"));
+const node_readline_1 = __importDefault(require("node:readline"));
+async function prompt(question) {
+    const rl = node_readline_1.default.createInterface({
+        input: process.stdin,
+        output: process.stdout,
+    });
+    return new Promise((resolve) => {
+        rl.question(question, (answer) => {
+            rl.close();
+            resolve(answer);
+        });
+    });
+}
+async function selectDomain() {
+    console.log("\n📚 What domain is your wiki for?");
+    console.log("  1) Code & Architecture");
+    console.log("  2) Research & Analysis");
+    console.log("  3) Business & Markets");
+    console.log("  4) Personal Knowledge");
+    let selection = "";
+    while (!["1", "2", "3", "4"].includes(selection)) {
+        selection = await prompt("Select (1-4): ");
+    }
+    const domains = {
+        "1": "code",
+        "2": "research",
+        "3": "business",
+        "4": "personal",
+    };
+    return domains[selection];
+}
+async function getProjectInfo(domain) {
+    console.log(`\n📝 Tell me about your ${domain} wiki`);
+    const name = await prompt("Project name (e.g., 'MyProject', 'Research2026'): ");
+    const description = await prompt("Brief description (what will this wiki track?): ");
+    return { name, description };
+}
+function getSchemaForDomain(domain) {
+    const schemas = {
+        code: `# Docuflow Wiki Schema - Code/Architecture
+
+## Domain
+Architecture and codebase documentation.
+
+## Wiki Structure
+
+### Entities (entities/)
+- Services: key microservices and components
+- APIs: public interfaces and endpoints  
+- Databases: data models and schemas
+- Frameworks: libraries and tools used
+
+### Concepts (concepts/)
+- Design Patterns: architectural and coding patterns
+- Principles: design principles and guidelines
+- Integrations: how components work together
+- Configuration: important settings and options
+
+### Syntheses (syntheses/)
+- Architecture Overview: system design
+- Decision Records: design decisions
+- Deployment Guide: how to deploy
+- API Reference: complete API docs
+
+### Timelines (timelines/)
+- Version History: evolution of the system
+- Roadmap: planned changes
+
+## Cross-Reference Patterns
+- "integrates with" - components/services that work together
+- "implemented by" - which entities implement a concept
+- "uses pattern" - which architecture patterns apply
+- "depends on" - dependencies between components
+
+## Metadata
+Each page should include:
+- created_at: when first documented
+- updated_at: last update date
+- tech_stack: relevant technologies
+- contributors: who wrote/contributed
+`,
+        research: `# Docuflow Wiki Schema - Research
+
+## Domain
+Research findings and analysis.
+
+## Wiki Structure
+
+### Entities (entities/)
+- Papers: academic papers and articles
+- Researchers: key people in the field
+- Conferences: important venues
+- Datasets: data sources used
+
+### Concepts (concepts/)
+- Methodologies: research methods
+- Theories: key theories and frameworks
+- Open Problems: unsolved questions
+- Keywords: important terms
+
+### Syntheses (syntheses/)
+- Literature Review: synthesis of papers
+- Findings: key discoveries
+- Future Work: research directions
+- Contradictions: areas of disagreement
+
+### Timelines (timelines/)
+- Research Evolution: how field evolved
+- Timeline of Discoveries: key milestones
+
+## Cross-Reference Patterns
+- "cites" - references between papers
+- "extends" - builds on prior work
+- "contradicts" - disagreement between sources
+- "validates" - experimental confirmation
+- "relates to" - topical connection
+
+## Metadata
+Each page should include:
+- created_at: when added
+- updated_at: last refresh
+- sources: which papers/sources
+- citations: number of times cited
+- confidence: how confident in findings
+`,
+        business: `# Docuflow Wiki Schema - Business
+
+## Domain
+Business and competitive analysis.
+
+## Wiki Structure
+
+### Entities (entities/)
+- Companies: competitors and partners
+- Products: key offerings
+- Markets: market segments
+- Customers: customer types
+
+### Concepts (concepts/)
+- Business Models: how companies make money
+- Market Segments: addressable markets
+- Capabilities: key competitive advantages
+- Trends: market trends
+
+### Syntheses (syntheses/)
+- Competitive Analysis: comparison matrix
+- Market Overview: market positioning
+- Opportunities: growth opportunities
+- Risks: market risks
+
+### Timelines (timelines/)
+- Market Evolution: how market changed
+- Competitive Timeline: competitor moves
+
+## Cross-Reference Patterns
+- "competes with" - direct competitors
+- "targets" - goes after customer/market
+- "partners with" - partnerships
+- "disrupts" - disruption threat
+- "complements" - complementary products
+
+## Metadata
+Each page should include:
+- created_at: when first documented
+- updated_at: last update
+- market_size: TAM/SAM/SOM if known
+- growth_rate: annual growth
+- sources: where info came from
+`,
+        personal: `# Docuflow Wiki Schema - Personal
+
+## Domain
+Personal knowledge, learning, and goals.
+
+## Wiki Structure
+
+### Entities (entities/)
+- Topics: areas of interest/expertise
+- Resources: books, courses, websites
+- People: mentors, collaborators
+- Projects: personal projects
+
+### Concepts (concepts/)
+- Learning Goals: what to learn
+- Skills: competencies to develop
+- Insights: key personal learnings
+- Practices: habits and routines
+
+### Syntheses (syntheses/)
+- Reflections: deeper thinking
+- Progress Updates: tracking learning
+- Connections: how ideas relate
+- Action Plans: what to do next
+
+### Timelines (timelines/)
+- Learning Journey: personal evolution
+- Milestones: key achievements
+
+## Cross-Reference Patterns
+- "builds on" - prerequisite knowledge
+- "connects to" - related topics
+- "informs" - influences thinking
+- "inspires" - inspiration source
+- "applies to" - practical application
+
+## Metadata
+Each page should include:
+- created_at: when started learning
+- updated_at: last review
+- relevance: importance (high/medium/low)
+- mastery_level: expertise level (beginner/intermediate/expert)
+- time_invested: hours spent
+`,
+    };
+    return schemas[domain];
+}
+function getPlanningTemplate(domain, projectName) {
+    return `# ${projectName} Wiki Plan
+
+## Goal
+Document and organize knowledge for ${projectName}.
+
+## Initial Sources to Add
+1. [ ] README or main overview
+2. [ ] Key source file 1
+3. [ ] Key source file 2
+
+## Key Entities to Define
+- Entity 1: [description]
+- Entity 2: [description]
+
+## Key Concepts to Extract
+- Concept 1: [description]
+- Concept 2: [description]
+
+## First Questions to Answer
+1. [What do you want to understand first?]
+2. [What relationships are important?]
+
+## Success Criteria
+- [ ] Successfully ingested first 3 sources
+- [ ] Created 10+ wiki pages
+- [ ] Can answer key questions
+- [ ] Wiki is at 80%+ health score
+
+## Next Review Date
+[Date for first maintenance check]
+`;
+}
+async function runInteractive() {
+    console.log("\n🌟 Welcome to Docuflow Wiki Setup!\n");
+    console.log("I'll help you set up a wiki for your project.");
+    console.log("This should take about 2 minutes. You can customize later.\n");
+    // Get domain
+    const domain = await selectDomain();
+    console.log(`✓ Selected: ${domain}`);
+    // Get project info
+    const { name: projectName, description } = await getProjectInfo(domain);
+    console.log(`✓ Project: "${projectName}" - ${description}`);
+    // Confirm setup
+    console.log("\n✨ I'll create a wiki structure for you with recommended schema.");
+    const confirm = await prompt("Ready to proceed? (y/n): ");
+    if (confirm.toLowerCase() !== "y") {
+        console.log("\n👋 Setup cancelled.");
+        return;
+    }
+    // Get schema for domain
+    const domainSchema = getSchemaForDomain(domain);
+    const planTemplate = getPlanningTemplate(domain, projectName);
+    console.log("\n📁 Creating wiki structure...");
+    const docuDir = node_path_1.default.join(process.cwd(), ".docuflow");
+    const wikiDir = node_path_1.default.join(docuDir, "wiki");
+    // Create directories
+    await promises_1.default.mkdir(node_path_1.default.join(wikiDir, "entities"), { recursive: true });
+    await promises_1.default.mkdir(node_path_1.default.join(wikiDir, "concepts"), { recursive: true });
+    await promises_1.default.mkdir(node_path_1.default.join(wikiDir, "syntheses"), { recursive: true });
+    await promises_1.default.mkdir(node_path_1.default.join(wikiDir, "timelines"), { recursive: true });
+    await promises_1.default.mkdir(node_path_1.default.join(docuDir, "sources"), { recursive: true });
+    await promises_1.default.mkdir(node_path_1.default.join(docuDir, "specs"), { recursive: true });
+    console.log("  ✓ Created wiki directories");
+    // Write schema with domain-specific content
+    await promises_1.default.writeFile(node_path_1.default.join(docuDir, "schema.md"), domainSchema, "utf8");
+    console.log("  ✓ Created schema.md with domain-specific structure");
+    // Write index and log
+    const indexContent = `# Wiki Index
+
+Auto-maintained catalog of all wiki pages.
+
+## Generated: ${new Date().toISOString()}
+
+(Index is automatically updated as you ingest sources)
+`;
+    await promises_1.default.writeFile(node_path_1.default.join(docuDir, "index.md"), indexContent, "utf8");
+    console.log("  ✓ Created index.md");
+    const logContent = `# Operation Log
+
+Record of all wiki operations.
+
+## [${new Date().toISOString()}] init | Wiki initialized
+- Domain: ${domain}
+- Project: ${projectName}
+- Description: ${description}
+`;
+    await promises_1.default.writeFile(node_path_1.default.join(docuDir, "log.md"), logContent, "utf8");
+    console.log("  ✓ Created log.md");
+    // Write planning template
+    const planPath = node_path_1.default.join(docuDir, "PLAN.md");
+    await promises_1.default.writeFile(planPath, planTemplate, "utf8");
+    console.log("  ✓ Created PLAN.md (interactive planning guide)");
+    console.log("\n✅ Wiki successfully initialized!\n");
+    // Print summary and next steps
+    console.log("📋 Next Steps:");
+    console.log("  1. Review your schema: .docuflow/schema.md");
+    console.log("  2. Review your plan: .docuflow/PLAN.md");
+    console.log("  3. Add first source: copy to .docuflow/sources/");
+    console.log("  4. Ask Claude: 'Ingest README.md into my wiki'");
+    console.log("  5. Ask Claude: 'What should my wiki contain?'");
+    console.log("\n💡 Tip: Open .claude/instructions.md to understand how Claude uses Docuflow\n");
+}

package/dist/commands/init.js

@@ -28,6 +28,35 @@ function resolveServerBin() {
         return node_path_1.default.resolve(__dirname, "..", "..", "server", "dist", "index.js");
     }
 }
+async function copyTemplateFile(templateName, destPath) {
+    try {
+        // Try package-installed location first
+        const templatePath = require.resolve(`@doquflow/cli/templates/${templateName}`);
+        const content = await promises_1.default.readFile(templatePath, "utf8");
+        await promises_1.default.writeFile(destPath, content, "utf8");
+    }
+    catch {
+        try {
+            // Fallback: monorepo sibling path (dev environment)
+            const templatePath = node_path_1.default.resolve(__dirname, "..", "..", "templates", templateName);
+            const content = await promises_1.default.readFile(templatePath, "utf8");
+            await promises_1.default.writeFile(destPath, content, "utf8");
+        }
+        catch (err) {
+            // If template not found, create a minimal version
+            console.warn(`  ⚠ Could not find template for ${templateName}, creating minimal version`);
+            if (templateName === "schema.md") {
+                await promises_1.default.writeFile(destPath, "# Docuflow Wiki Schema\n\n## Domain\n[Edit this file to customize your wiki]\n", "utf8");
+            }
+            else if (templateName === "index.md") {
+                await promises_1.default.writeFile(destPath, "# Wiki Index\n\nAuto-maintained catalog of pages.\n", "utf8");
+            }
+            else if (templateName === "log.md") {
+                await promises_1.default.writeFile(destPath, "# Operation Log\n\nRecord of wiki operations.\n", "utf8");
+            }
+        }
+    }
+}
 async function run() {
     const configPath = getClaudeDesktopConfigPath();
     const serverBin = resolveServerBin();
@@ -46,9 +75,25 @@ async function run() {
     config.mcpServers.docuflow = { command: nodeBin, args: [serverBin] };
     await promises_1.default.mkdir(node_path_1.default.dirname(configPath), { recursive: true });
     await promises_1.default.writeFile(configPath, JSON.stringify(config, null, 2) + "\n", "utf8");
-    // Create .docuflow/specs/ in cwd
-    const specsDir = node_path_1.default.join(process.cwd(), ".docuflow", "specs");
+    // Create .docuflow/ directory structure
+    const docuflowDir = node_path_1.default.join(process.cwd(), ".docuflow");
+    const specsDir = node_path_1.default.join(docuflowDir, "specs");
+    const wikiDir = node_path_1.default.join(docuflowDir, "wiki");
+    const sourcesDir = node_path_1.default.join(docuflowDir, "sources");
+    const entitiesDir = node_path_1.default.join(wikiDir, "entities");
+    const conceptsDir = node_path_1.default.join(wikiDir, "concepts");
+    const timelinesDir = node_path_1.default.join(wikiDir, "timelines");
+    const synthesesDir = node_path_1.default.join(wikiDir, "syntheses");
     await promises_1.default.mkdir(specsDir, { recursive: true });
+    await promises_1.default.mkdir(entitiesDir, { recursive: true });
+    await promises_1.default.mkdir(conceptsDir, { recursive: true });
+    await promises_1.default.mkdir(timelinesDir, { recursive: true });
+    await promises_1.default.mkdir(synthesesDir, { recursive: true });
+    await promises_1.default.mkdir(sourcesDir, { recursive: true });
+    // Copy or create template files
+    await copyTemplateFile("schema.md", node_path_1.default.join(docuflowDir, "schema.md"));
+    await copyTemplateFile("index.md", node_path_1.default.join(docuflowDir, "index.md"));
+    await copyTemplateFile("log.md", node_path_1.default.join(docuflowDir, "log.md"));
     // 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)) {
@@ -57,11 +102,28 @@ async function run() {
             await promises_1.default.appendFile(gitignorePath, "\n# Docuflow\n.docuflow/\n");
         }
     }
-    console.log("Docuflow initialised successfully.");
+    console.log("✓ Docuflow initialised successfully.");
+    console.log("");
+    console.log("📁 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("");
+    console.log("🔧 MCP Configuration:");
     console.log(`  MCP key:     mcpServers.docuflow`);
     console.log(`  Config file: ${configPath}`);
-    console.log(`  Specs dir:   ${specsDir}`);
     console.log("");
-    console.log("Restart Claude Desktop to activate.");
+    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 LLM Wiki tools to ingest, query, and maintain wiki");
+    console.log("  4. Restart Claude Desktop to activate");
 }

package/package.json

@@ -1,16 +1,39 @@
 {
   "name": "@doquflow/cli",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "CLI for setting up Docuflow in your project",
   "author": "Docuflow <hello@doquflows.dev>",
   "license": "MIT",
   "homepage": "https://github.com/doquflows/docuflow",
-  "repository": { "type": "git", "url": "https://github.com/doquflows/docuflow.git" },
-  "bugs": { "url": "https://github.com/doquflows/docuflow/issues" },
-  "keywords": ["mcp", "ai-agents", "claude-code", "documentation", "developer-tools"],
-  "bin": { "docuflow": "./dist/index.js" },
-  "files": ["dist/**", "README.md"],
-  "scripts": { "build": "tsc" },
-  "dependencies": { "@doquflow/server": "0.1.1" },
-  "devDependencies": { "@types/node": "^22.0.0", "typescript": "^5.6.0" }
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/doquflows/docuflow.git"
+  },
+  "bugs": {
+    "url": "https://github.com/doquflows/docuflow/issues"
+  },
+  "keywords": [
+    "mcp",
+    "ai-agents",
+    "claude-code",
+    "documentation",
+    "developer-tools"
+  ],
+  "bin": {
+    "docuflow": "./dist/index.js"
+  },
+  "files": [
+    "dist/**",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc"
+  },
+  "dependencies": {
+    "@doquflow/server": "0.3.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "^5.6.0"
+  }
 }