Editor Setup

Supersigil provides editor extensions that connect to the supersigil-lsp language server, giving you live diagnostics, go-to-definition, autocomplete, and hover documentation directly in your editor.

What you get

• Rendered spec previews — supersigil-xml blocks render as rich, interactive components in the Markdown preview. Each criterion shows its verification state as a colored badge (Verified, Unverified, Partial, or Failing). Click “Evidence (N)” to see which tests verify a criterion, with links to the test source file and line. Implements, DependsOn, and References render as navigable link pills. The preview updates automatically when you save.
• Live diagnostics — parse errors, broken refs, missing coverage, and structural issues appear as you type and save.
• Go-to-definition — jump from a ref like auth/req#req-1-1 to the criterion’s source location.
• Autocomplete — document IDs, criterion IDs, component names with attribute snippets, and context-sensitive status/strategy values.
• Hover documentation — hover over a ref to see the target’s title, body text, and a link to the source location.
• Supersigil Specifications — a tree view in the Explorer sidebar showing all spec documents grouped by feature area, with status indicators and click-to-open navigation. Hover over a document to open it in the graph explorer.
• In-editor graph explorer — open the full interactive spec graph inside VS Code with the graph icon in the editor title bar. Click any node to see its details, click “Open File” to jump to the source, or click evidence links to open test files at the exact line. The graph updates live as specs change. See the graph explorer guide for details.

Installation

If you installed Supersigil via Homebrew or AUR, the supersigil-lsp language server is already on your $PATH. For other installation methods, install it separately:

cargo install supersigil-lsp

Then install the extension for your editor:

VS Code

Install from the VS Code Marketplace or Open VSX:

code --install-extension supersigil.supersigil

Open any folder containing a supersigil.toml. The extension activates automatically and starts the language server. You should see Supersigil in the status bar.

Run verification from the command palette with Supersigil: Verify. Multi-root workspaces are supported — each folder with a supersigil.toml gets its own LSP server instance.

IntelliJ IDEA

Install from the JetBrains Marketplace or open Settings > Plugins > Marketplace and search for Supersigil.

For local development, you can still build and install the plugin from the repository:

cd editors/intellij
./gradlew buildPlugin

Then in IntelliJ: Settings > Plugins > gear icon > Install Plugin from Disk… and select the generated .zip from build/distributions/. Restart when prompted.

Open any project containing a supersigil.toml and open a .md or .mdx file. The plugin starts the language server automatically. The Supersigil tool window appears in the right sidebar with a tree view of all specs and a verify button.

Requires IntelliJ IDEA 2025.3 or later (the unified distribution). Works with all IntelliJ-based IDEs that include the LSP client module.

Configuration

Both extensions have one setting: the path to the supersigil-lsp binary. When not set, the extension searches $PATH and common install locations (~/.cargo/bin, ~/.local/bin). If the binary is not found, a notification appears with install instructions.

Editor	Setting
VS Code	supersigil.lsp.serverPath
IntelliJ	Settings > Tools > Supersigil

Other editors

The supersigil-lsp binary communicates over stdio and implements the Language Server Protocol. It works with any LSP-capable editor:

• Neovim — configure via nvim-lspconfig with cmd = {"supersigil-lsp"} and filetypes = {"markdown", "mdx"}.
• Zed — add an LSP entry in settings pointing to the binary.
• Helix — add to languages.toml under the markdown language.

Editor-specific extensions for these editors are not yet available but the raw LSP works today.