LOCKDOCS MANUAL

lockdocs capabilities

What lockdocs can do today and where the code is. CI checks that every path in the Code column exists (scripts/check-capabilities.ts). The destination is in vision.md.

IDCapabilityStatusCodeDepends on
LD-LOCKFILERead exact versions from npm, pnpm, Yarn, Bun, Cargo, uv, Poetry, PDM, Pipenv, pip requirements and Go lockfilessupportedcrates/lockdocs-core/src/lockfile.rs, crates/lockdocs-core/src/project.rs
LD-LOCATEFind each package's files on disk (node_modules, Yarn Plug'n'Play, virtualenvs, Cargo registry and git checkouts, Go module cache)supportedcrates/lockdocs-core/src/locate.rsLD-LOCKFILE
LD-REGISTRY-FETCHDownload a pinned package that is not installed, from its registry (opt-in)supportedcrates/lockdocs-core/src/fetch.rsLD-LOCKFILE
LD-UPSTREAMDownload the docs folders of a package's GitHub repository at the immutable commit resolved from the pinned release tag (automatic on first query; opt-out/offline supported)supportedcrates/lockdocs-core/src/upstream.rsLD-LOCATE
LD-DOCS-SITEAdd an official docs-site repository for the pinned major: the default branch for the latest major, a vN branch or the last commit before the next major for older ones (React, Express, Tailwind CSS, Prisma, tokio)partialcrates/lockdocs-core/src/upstream.rsLD-UPSTREAM
LD-EXTRACTSplit Markdown, MDX, reStructuredText and component-based docs pages into sections; extract TypeScript, Python, Rust and Go symbols with signatures and doc commentssupportedcrates/lockdocs-core/src/extract.rs, crates/lockdocs-core/src/markdown.rsLD-LOCATE
LD-INDEXCache one index per package, version and source locationsupportedcrates/lockdocs-core/src/index.rs, crates/lockdocs-core/src/cache.rsLD-EXTRACT
LD-SEARCHRank sections and symbols: BM25 on full text and on headings, a local embedding model, and docs-specific signalssupportedcrates/lockdocs-core/src/bm25.rs, crates/lockdocs-core/src/semantic.rs, crates/lockdocs-core/src/query.rsLD-INDEX
LD-MCPMCP server with the resolve, docs and api tools over stdiosupportedcrates/lockdocs/src/mcp.rs, crates/lockdocs/src/tools.rsLD-SEARCH
LD-CLICommand line with the same queries, plus index, fetch and setupsupportedcrates/lockdocs/src/main.rs, crates/lockdocs/src/setup.rsLD-SEARCH
LD-NPMnpm launcher and native binaries for five platformssupportedpackages/lockdocs, packages/npmLD-CLI
LD-BENCHVersion-sensitive benchmark against Context7, run on GitHub-hosted runnerssupportedbench/run.py, bench/questions.json, .github/workflows/bench.ymlLD-CLI
LD-CLOUDThe same version-sensitive corpus asked through the Sylphx Search cloud docs index (POST /v1/web/search, category: code) and graded with the same grader, so the local and cloud arms compare on one answer setsupportedbench/cloud.pyLD-BENCH
LD-PRO-LICENCElockdocs Pro licence: offline token check, licence status/activate, the pro_required answersupportedcrates/lockdocs/src/pro.rs
LD-PRO-UPGRADEPro: upgrade report, an API diff from the pinned version to a target, limited to the symbols the project calls, with call sitessupportedcrates/lockdocs-core/src/upgrade.rsLD-REGISTRY-FETCH, LD-EXTRACT, LD-PRO-LICENCE
LD-PRO-PRIVATEPro: read packages and upstream docs from the private registries and git hosts the project already configures (.npmrc, uv and pip config, .cargo/config.toml, GOPROXY/GOPRIVATE, ~/.netrc, token variables, git credential fill), each credential sent only to its own hostsupportedcrates/lockdocs-core/src/private, crates/lockdocs-core/src/fetch.rs, crates/lockdocs-core/src/upstream.rs, crates/lockdocs/src/pro.rsLD-REGISTRY-FETCH, LD-UPSTREAM, LD-PRO-LICENCE