@doquflow/cli 0.4.0 → 0.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -11
- package/dist/index.js +14 -3
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,38 +1,83 @@
|
|
|
1
1
|
# @doquflow/cli
|
|
2
2
|
|
|
3
|
-
CLI for setting up Docuflow in your project. Registers the MCP server in Claude Desktop
|
|
3
|
+
CLI for setting up Docuflow in your project. Registers the MCP server in Claude Desktop, scaffolds `.docuflow/`, generates `CLAUDE.md`, and gives domain-aware onboarding guidance.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @doquflow/cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Or use without installing:
|
|
6
12
|
|
|
7
13
|
```bash
|
|
8
14
|
npx @doquflow/cli init
|
|
9
15
|
```
|
|
10
16
|
|
|
11
|
-
|
|
17
|
+
## Commands
|
|
18
|
+
|
|
19
|
+
### `docuflow init`
|
|
20
|
+
|
|
21
|
+
One command to:
|
|
22
|
+
- Create `.docuflow/` directory structure (sources/, wiki/, specs/, schema.md, index.md, log.md)
|
|
12
23
|
- Register the `@doquflow/server` MCP server in your Claude Desktop config
|
|
13
|
-
-
|
|
14
|
-
|
|
24
|
+
- Generate `CLAUDE.md` at the project root so Claude auto-discovers all 15 tools
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
docuflow init
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### `docuflow init --interactive`
|
|
31
|
+
|
|
32
|
+
Interactive domain-aware setup:
|
|
33
|
+
- Choose your domain: Code/Architecture, Research, Business, or Personal
|
|
34
|
+
- Enter project name and description
|
|
35
|
+
- Auto-generates a domain-specific schema template
|
|
36
|
+
- Creates a planning template (PLAN.md)
|
|
37
|
+
- Generates CLAUDE.md
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
docuflow init --interactive
|
|
41
|
+
# or: docuflow init -i
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### `docuflow status`
|
|
45
|
+
|
|
46
|
+
Shows current Docuflow state:
|
|
47
|
+
- Package version
|
|
48
|
+
- MCP server registration status
|
|
49
|
+
- CLAUDE.md presence
|
|
50
|
+
- Wiki page counts by category (entities, concepts, syntheses, timelines)
|
|
51
|
+
- Source file count
|
|
52
|
+
- Last ingest date
|
|
53
|
+
- Smart hints
|
|
15
54
|
|
|
16
55
|
```bash
|
|
17
|
-
|
|
56
|
+
docuflow status
|
|
18
57
|
```
|
|
19
58
|
|
|
20
|
-
|
|
59
|
+
### `docuflow suggest`
|
|
60
|
+
|
|
61
|
+
Domain-aware first-steps guidance. Reads your domain from `.docuflow/schema.md`, counts existing wiki pages and sources, then prints 5 prioritised suggestions with reasons and ready-to-paste Claude prompt starters.
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
docuflow suggest
|
|
65
|
+
```
|
|
21
66
|
|
|
22
67
|
## How it works
|
|
23
68
|
|
|
24
|
-
After running `init`, open Claude Desktop
|
|
69
|
+
After running `init`, open Claude Desktop (or any MCP-compatible agent) and start working:
|
|
25
70
|
|
|
26
71
|
```
|
|
27
|
-
|
|
72
|
+
Scan src/ with list_modules and write wiki pages for each major module.
|
|
28
73
|
```
|
|
29
74
|
|
|
30
|
-
Claude will call
|
|
75
|
+
Claude will call Docuflow's 15 MCP tools to read files, build a wiki, and answer questions about your codebase — persisting knowledge that compounds over time.
|
|
31
76
|
|
|
32
77
|
## Requirements
|
|
33
78
|
|
|
34
79
|
- Node.js 18+
|
|
35
|
-
- Claude Desktop
|
|
80
|
+
- Claude Desktop, Cursor, Copilot, or any MCP-compatible agent
|
|
36
81
|
|
|
37
82
|
## License
|
|
38
83
|
|
package/dist/index.js
CHANGED
|
@@ -33,8 +33,13 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
33
33
|
return result;
|
|
34
34
|
};
|
|
35
35
|
})();
|
|
36
|
+
// eslint-disable-next-line @typescript-eslint/no-var-requires
|
|
37
|
+
const { version } = require('../package.json');
|
|
36
38
|
const [, , cmd, flag] = process.argv;
|
|
37
|
-
if (cmd === '
|
|
39
|
+
if (cmd === '--version' || cmd === '-v') {
|
|
40
|
+
console.log(version);
|
|
41
|
+
}
|
|
42
|
+
else if (cmd === 'init') {
|
|
38
43
|
if (flag === '--interactive' || flag === '-i') {
|
|
39
44
|
Promise.resolve().then(() => __importStar(require('./commands/init-interactive'))).then(m => m.runInteractive());
|
|
40
45
|
}
|
|
@@ -49,10 +54,16 @@ else if (cmd === 'suggest') {
|
|
|
49
54
|
Promise.resolve().then(() => __importStar(require('./commands/suggest'))).then(m => m.run());
|
|
50
55
|
}
|
|
51
56
|
else {
|
|
52
|
-
console.log(
|
|
57
|
+
console.log(`DocuFlow v${version}`);
|
|
58
|
+
console.log('');
|
|
59
|
+
console.log('Usage: docuflow <command>');
|
|
53
60
|
console.log('');
|
|
54
|
-
console.log('
|
|
61
|
+
console.log('Commands:');
|
|
62
|
+
console.log(' init Register DocuFlow MCP and generate CLAUDE.md');
|
|
55
63
|
console.log(' init --interactive Interactive setup wizard (choose domain, project name)');
|
|
56
64
|
console.log(' status Show wiki health, page counts, and MCP status');
|
|
57
65
|
console.log(' suggest Show what to document first (domain-specific guidance)');
|
|
66
|
+
console.log('');
|
|
67
|
+
console.log('Options:');
|
|
68
|
+
console.log(' --version, -v Print version number');
|
|
58
69
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@doquflow/cli",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.2",
|
|
4
4
|
"description": "CLI for setting up Docuflow in your project",
|
|
5
5
|
"author": "Docuflow <hello@doquflows.dev>",
|
|
6
6
|
"license": "MIT",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"build": "tsc"
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"@doquflow/server": "0.4.
|
|
33
|
+
"@doquflow/server": "0.4.2"
|
|
34
34
|
},
|
|
35
35
|
"devDependencies": {
|
|
36
36
|
"@types/node": "^22.0.0",
|