reference

CLI Reference

Reference for docs retrieval, hybrid query modes, Qdrant lifecycle, API MCP packs, and agent setup.

Updated

docmancer setup

Create the local config and database, then install selected agent integrations.

docmancer setup [options]
FlagDescription
--allInstall all agent integrations non-interactively
--agent <name>Install a specific agent (repeatable)

docmancer ingest

Index local files into the SQLite FTS5 + Qdrant hybrid index.

docmancer ingest <path> [options]

Supported formats: Markdown, plain text, PDF, DOCX, RTF, HTML. PDF/DOCX/RTF/HTML need pip install 'docmancer[local]'.

FlagDefaultDescription
--no-vectorsoffSkip Qdrant; index lexical-only (FTS5)
--recreateoffDrop and rebuild the index for this source
--workersautoConcurrent parsing workers

By default, ingest auto-syncs vectors when an opt-in is present (DOCMANCER_QDRANT_URL, DOCMANCER_AUTO_VECTORS=1, or an installed managed Qdrant binary). Otherwise it is a silent no-op so first runs do not trigger background downloads.

docmancer add

Fetch and index docs from a URL or GitHub repo.

docmancer add <url> [options]
FlagDefaultDescription
--providerautoForce provider: auto, gitbook, mintlify, web, github, crawl4ai
--strategyautoForce discovery strategy (llms-full.txt, sitemap.xml, nav-crawl)
--max-pages500Maximum pages to fetch
--browseroffEnable Playwright for JS-heavy sites (requires docmancer[browser])
--fetch-workersautoConcurrent page fetch workers
--recreateoffDrop and rebuild the index for this source

docmancer query

Run a query through the retrieval dispatcher.

docmancer query "<question>" [options]
FlagDefaultDescription
--modelexicalOne of lexical, dense, sparse, hybrid. Auto-flips to hybrid when vector_store: is configured in YAML.
--explainoffAnnotate each result with per-source rank (lexical#1, dense#3, sparse#2)
--budget2400Maximum estimated output tokens
--limitautoMaximum sections to return
--expandadjacentnone, adjacent, or page
--formatmarkdownOutput format: markdown or json

docmancer qdrant

Manage the Docmancer-owned local Qdrant lifecycle.

docmancer qdrant up
docmancer qdrant down
docmancer qdrant status
docmancer qdrant upgrade
docmancer qdrant logs

up starts the pinned Qdrant binary (downloads on first run). down stops it cleanly. status reports running state, port, and storage path. upgrade rolls the pinned release version. logs tails the Qdrant log file.

docmancer update

Re-fetch and re-index documentation sources.

docmancer update [source]

Same flags as add for browser, page caps, etc.

docmancer list

Show indexed documentation sources.

docmancer list [--all]

--all shows every individual page or file rather than only roots.

docmancer inspect

Show SQLite + vector store stats, format breakdown, and drift warnings.

docmancer inspect

docmancer remove

Remove a source or clear the entire index.

docmancer remove <source>
docmancer remove --all

--all clears all indexed content but keeps your config.

docmancer install-pack

Install a local API MCP pack.

docmancer install-pack <package>@<version> [options]

The installer tries local cache, the hosted Docmancer artifact API, and built-in known-source fallback (compiles supported packs like open-meteo from public OpenAPI). It can also compile from a URL you provide:

FlagDescription
--from-url <url>Compile package@version from a public OpenAPI 3.x or Swagger 2.0 spec URL
--expandedActivate the full tool surface instead of the curated subset
--allow-destructivePermit destructive operations for this pack
--allow-executePermit executor types such as python_import

docmancer mcp

Manage the local API MCP runtime and installed packs.

docmancer mcp serve
docmancer mcp list
docmancer mcp doctor
docmancer mcp enable <package> [--version <version>]
docmancer mcp disable <package> [--version <version>]
docmancer mcp remove <package>[@<version>]

docmancer mcp serve is the stdio server agents launch for API MCP packs. It is separate from the docs-retrieval skill flow that calls docmancer query.

docmancer uninstall

Remove an installed API MCP pack.

docmancer uninstall <package>[@<version>]

docmancer install

Install or refresh the Docmancer skill or instructions file for one agent.

docmancer install <agent> [--project]

Agents: claude-code, claude-desktop, cline, cursor, codex, codex-app, codex-desktop, gemini, github-copilot, opencode. Use --project to install in a project-level skills directory (supported for Claude Code, Gemini, Cline, GitHub Copilot). Use docmancer setup for the normal first-time flow.

docmancer doctor

End-to-end health check.

docmancer doctor

Reports config status, SQLite index health, loader availability, Qdrant status, embeddings provider, vector / lexical drift, and installed agent skills.

docmancer init

Create a project-local docmancer.yaml.

docmancer init [--dir <path>]

docmancer fetch

Download docs from a GitBook-style URL to local Markdown without indexing.

docmancer fetch <url> --output <dir>