Installation¶

Docuflow is distributed as an npm package. The CLI meta-package (@doquflow/cli) installs everything you need.

Requirements¶

Node.js 18 or later
An MCP-compatible AI agent: Claude Desktop, VS Code + GitHub Copilot, or Cursor

Install options¶

Global install (recommended)npx (no install)Project-local (CI/CD)

npm install -g @doquflow/cli

Installs the docuflow command globally. Run it from any project directory.

docuflow --version   # verify install
docuflow --help      # see all commands

npx @doquflow/cli init

Runs the latest version without a permanent install. Best for one-off initialisation.

npm install --save-dev @doquflow/cli

Then call via npx docuflow or add to your package.json scripts:

{
  "scripts": {
    "docuflow:sync": "docuflow sync --ai"
  }
}

Package breakdown¶

Docuflow v2.0 is split into focused packages:

Package	npm	Description
`@doquflow/cli`		CLI meta-package — install this for everything
`@doquflow/core`		4 core MCP tools: `query_wiki`, `ingest_source`, `wiki_search`, `read_module`
`@doquflow/studio`		11 advanced tools + Web UI + REST API
`@doquflow/server`		Back-compat alias for `@doquflow/studio` (existing registrations keep working)

Existing users

If you have @doquflow/server registered in .mcp.json, it keeps working without modification. The v2.0 server package re-exports studio transparently.

Migrating from v1.x¶

See MIGRATION.md for the full upgrade guide.

Short version: npm install -g @doquflow/cli — no config changes needed.

Verify installation¶

docuflow doctor

This runs a full diagnostic: installed package versions, MCP registration status, wiki health, and recommendations.