LOCKDOCS MANUAL

lockdocs vision

What we are building

lockdocs gives AI coding agents the documentation for the exact library versions a project uses. It reads the project's lockfile, finds each package on disk (or downloads that exact version when asked), and answers questions from that version's own files: its README, docs folders, type declarations and doc comments, plus the upstream docs at the version's git tag.

An agent that writes code for Next.js 14 should get the Next.js 14 API, not the newest one. That is the one job.

Who it is for

  • Developers who use an AI coding agent (Claude Code, Codex, Cursor, VS Code, Windsurf, Gemini CLI) on projects that do not track the newest release of every dependency.
  • Teams that cannot send their dependency list to a hosted service, or that hit rate limits on one.

Boundaries

  • Local first: it runs on the developer's machine, needs no account, and works offline after the one-time downloads. The free product needs no key of any kind; lockdocs Pro is unlocked by a licence token that is verified offline, never by an account or a call to us.
  • First-use release-tag docs are anonymous and automatic, with an explicit opt-out and an offline mode. Registry downloads and major-version docs sites remain opt-in. Without Pro, network use is limited to public sources: package registries, GitHub (docs folders at a tag, and official docs-site repositories), and the embedding model on Hugging Face. With Pro, lockdocs also reads the private registries and git hosts the user has configured, with the user's own credentials, sent only to the host they belong to.
  • Three MCP tools only: resolve, docs, api. New abilities, Pro included, go into those tools, not into more tools.
  • Four ecosystems: npm, PyPI, Cargo and Go. A new ecosystem needs a lockfile parser, a way to find installed files, and a symbol extractor.
  • No hosted index for lockdocs itself. We do not crawl or store other people's documentation on the lockdocs side: lockdocs reads the package files already on the machine and builds its index there. Sylphx Search, our separate platform service, is the cloud index for public documentation lockdocs cannot reach locally (a package that is not installed, a docs website that ships nothing inside the package); lockdocs is its local arm, and the same version-sensitive questions and grader measure both, so the two are one index format and one ranking rather than two products. Team index packs are built and stored by the customer, in the customer's own registry or storage.

Free and Pro

Everything lockdocs does for free stays free, under MIT. lockdocs Pro sells only new value for teams: private sources that are not installed, signed team index packs, the upgrade report, and support. A capability never moves from free to Pro.

What good looks like

  • On the version-sensitive benchmark (bench/), lockdocs is correct at least as often as the best hosted alternative on every column: older majors, newer majors, single-version libraries and the held-out questions. Results are measured on GitHub-hosted runners and published as they come out.
  • A question costs tens of milliseconds and about a thousand tokens.
  • Every answer cites package@version path:line, so an agent or a person can check it.

Current capabilities and their code: capabilities.md.