@doquflow/cli 0.1.0 → 0.1.1
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 +39 -0
- package/package.json +3 -3
package/README.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# @doquflow/cli
|
|
2
|
+
|
|
3
|
+
CLI for setting up Docuflow in your project. Registers the MCP server in Claude Desktop and scaffolds `.docuflow/specs/`.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx @doquflow/cli init
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
That's it. One command to:
|
|
12
|
+
- Register the `@doquflow/server` MCP server in your Claude Desktop config
|
|
13
|
+
- Create `.docuflow/specs/` in your current project
|
|
14
|
+
- Add `.docuflow/` to `.gitignore`
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npx @doquflow/cli status
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Shows how many specs are written and whether the MCP server is registered.
|
|
21
|
+
|
|
22
|
+
## How it works
|
|
23
|
+
|
|
24
|
+
After running `init`, open Claude Desktop and ask it to document your codebase:
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
Read the modules in src/ and write specs for each one.
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Claude will call the Docuflow MCP tools to read your files and write living markdown specs to `.docuflow/specs/`. No API keys, no uploads, no AI inside the server.
|
|
31
|
+
|
|
32
|
+
## Requirements
|
|
33
|
+
|
|
34
|
+
- Node.js 18+
|
|
35
|
+
- Claude Desktop
|
|
36
|
+
|
|
37
|
+
## License
|
|
38
|
+
|
|
39
|
+
MIT — [github.com/doquflows/docuflow](https://github.com/doquflows/docuflow)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@doquflow/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "CLI for setting up Docuflow in your project",
|
|
5
5
|
"author": "Docuflow <hello@doquflows.dev>",
|
|
6
6
|
"license": "MIT",
|
|
@@ -9,8 +9,8 @@
|
|
|
9
9
|
"bugs": { "url": "https://github.com/doquflows/docuflow/issues" },
|
|
10
10
|
"keywords": ["mcp", "ai-agents", "claude-code", "documentation", "developer-tools"],
|
|
11
11
|
"bin": { "docuflow": "./dist/index.js" },
|
|
12
|
-
"files": ["dist/**"],
|
|
12
|
+
"files": ["dist/**", "README.md"],
|
|
13
13
|
"scripts": { "build": "tsc" },
|
|
14
|
-
"dependencies": { "@doquflow/server": "0.1.
|
|
14
|
+
"dependencies": { "@doquflow/server": "0.1.1" },
|
|
15
15
|
"devDependencies": { "@types/node": "^22.0.0", "typescript": "^5.6.0" }
|
|
16
16
|
}
|