Documentation

Everything here is generated from the Markdown in the repository, so the site and the repo cannot drift apart.

  • Quickstart. Install Stacklit and generate a codebase index in one command.
  • How it works. The Stacklit pipeline: scan, parse with tree-sitter, build modules and a dependency graph, render outputs.
  • Commands reference. Every stacklit command and flag: init, generate, view, diff, derive, export, setup, serve, query, check and more.
  • MCP tools. The read-only tools the Stacklit MCP server exposes over the index and the symbol graph.
  • Assistants and setup. Wire Claude Code, Cursor, Aider and other AI tools to a Stacklit index with one command.
  • Configuration. The .stacklitrc.json keys and STACKLIT_ environment variables that control a Stacklit scan.
  • Sessions and hooks. Session persistence and hooks for Stacklit. Coming with 0.5.0.
  • Languages. Which languages and formats Stacklit indexes and what it extracts from each.
  • Privacy. Stacklit runs locally, has no telemetry and no account. What it reads, writes and sends.
  • FAQ. Answers on small repos, grep, dependency accuracy, unsupported languages and git hooks.
  • Index format. How to read stacklit.json, and how Stacklit handles monorepos and several repos at once.
  • CI and troubleshooting. Keep the index fresh in CI with the GitHub Action or a hook, and fix common problems.
  • Benchmarks. A deterministic token-cost proxy on six pinned repos and 58 tasks, with intervals, the methodology, the misses and the limitations.
  • Changelog. Release history for Stacklit.