Skip to content

Latest commit

 

History

History

README.md

docsiq — User Documentation

docsiq is a GraphRAG documentation-search tool: it ingests PDFs, DOCX, Markdown, plain text and docs websites, builds a knowledge graph with community detection, and exposes that graph to AI coding agents over the Model Context Protocol (MCP) and over a local REST + Web UI.

This directory holds the user-facing guides. Developer-facing notes (internals, commit history, per-package READMEs) live elsewhere in the repo.

Table of contents

  • Getting started — prerequisites, install, first project, smoke test
  • CLI reference — every subcommand and flag (docsiq init|serve|index|stats|projects|hooks|vec|version)
  • MCP tools — the 19 MCP tools exposed at POST /mcp (12 docs + 7 notes)
  • REST API — every /api/* endpoint, auth model, query / body / response shapes
  • Configuration — every config field: env var, default, type, purpose
  • Hooks — SessionStart hook integration with Claude Code, Cursor, Copilot CLI, Codex CLI
  • Architecture — per-project store layout, registry, HNSW flow, a diagram

Start with Getting started if you're new. Jump to CLI reference, MCP tools, or REST API as a lookup. The Configuration and Architecture pages explain the shape of ~/.docsiq/config.yaml and the on-disk data directory.