VS Code & LSP
Install the Crux editor extension or connect another editor to the language server.
The Crux VS Code extension is the packaged editor experience. It discovers the
crux binary, starts crux lsp, displays diagnostics and inline findings, and
adds commands for opening Devtools and restarting the language server.
Install the CLI and the matching VSIX from the same GitHub Release:
npm install -g @use-crux/local
code --install-extension crux-vscode-<version>.vsixThe extension also works in compatible VS Code-based editors. Other editors can
start crux lsp over stdio with a custom LSP configuration.
Use the editor integration for:
- diagnostics and rule actions;
- go to definition, references, symbols, and source-aware hover;
- inlay hints and code lenses linked to indexed Crux definitions; and
- semantic completion in supported Crux dependency slots.
Most Project Index features are based on saved files. Semantic completion is the exception: it uses a bounded, request-only overlay of the current unsaved document and never writes that text into the Project Index or cache.
VS Code and LSP reference
Installation, workspace trust, binary discovery, settings, diagnostics, navigation, and editor configuration.
Semantic completion
Supported slots, import behavior, unsaved text, privacy, and limitations.
Project Health
Understand the source model behind editor diagnostics and navigation.
The extension and language server are one toolchain, but distinct layers: the
extension supplies the VS Code user interface, while crux lsp is the
editor-neutral protocol server.