# Editors

> Keryn in VS Code, JetBrains IDEs, Zed, Warp, Neovim, Helix, Sublime Text, Emacs and Kate, and which of them are released.

Source: https://keryn.dev/docs/guides/editors/

## Goal

See Keryn's findings and the AI-BOM in your editor as you work, with the same engine, rules and proof levels as the CLI.

## Before you start

- Your editor: VS Code (also Cursor and Windsurf), a JetBrains IDE (2024.1 or later), or any editor with a language server client.
- To install an extension: as of release 0.5.2 no editor extension is in a store. Release 0.5.2 shipped the sites and the Keryn Cloud API only. The extensions below are built and tested from source; the [install page](https://keryn.dev/docs/start/install/) shows which artifacts are live. See [apps and integrations](https://keryn.dev/docs/guides/apps/) for the status of every surface.
- For JetBrains and for the language server: the Keryn CLI on `PATH` ([install](https://keryn.dev/docs/start/install/)). The VS Code extension carries its own engine.
- A repository. Optionally a `.keryn.yml` ([configuration](https://keryn.dev/docs/reference/config/)): every surface reads it, so the editor and CI agree.

## VS Code, Cursor, Windsurf

Keryn for VS Code (`keryn.keryn`) runs the engine locally in the extension host:

- diagnostics on save for the whole workspace, with the proof level in each message,
- **Keryn AI-BOM** in the Explorer, and **Keryn change**: the AI components a change adds against a base (`keryn.delta.base`: a git ref, `merge-base`, or a CycloneDX file),
- commands: **Scan workspace**, **Show AI-BOM**, **Deep**, **Export SARIF**, **Export evidence bundle**,
- a quick fix that suppresses one finding with a `nosemgrep` comment.

In an untrusted workspace the extension reads file text only; it never runs workspace code.

The extension is built but not yet published: the `.vsix` is a release artifact that does not exist yet, and the Visual Studio Marketplace (publisher `keryn`) and Open VSX listings are not live. It needs VS Code 1.90 or later.

## JetBrains IDEs

Keryn for JetBrains (IntelliJ-based IDEs 2024.1 and later) runs the Keryn CLI in the background on demand or on save, and shows the results in the editor, the Problems view and a **Keryn AI-BOM** tool window. It finds `keryn` on `PATH`, or runs the command you set in its settings. No network use of its own, no telemetry, no update checks. Its id is `dev.keryn.jetbrains`.

Open **Settings, Tools, Keryn AI-BOM** to choose the CLI, rule packs (empty means your `.keryn.yml` or the CLI default; `bundled:aibom` is inventory only), include and exclude globs, the gate threshold, a policy, scope, Deep and scan on save. Then run **Tools, Keryn, Scan Project**. Scans read saved files: unsaved buffers are not scanned, so save and rescan.

> **Note: In the next release**
> Finding explanations (rule message, location, confidence, proof and fingerprint), Git or BOM change review against a ref or a baseline CycloneDX file, cancellation, and exact CycloneDX, SARIF and native-result exports are in the Keryn source after release 0.5.2 and in no release yet. An explanation describes the scanner's evidence; it does not assert exploitability.

The plugin is built but not published: the plugin zip is a release artifact that does not exist yet, and the JetBrains Marketplace listing is not live.

## Any LSP client

Every other editor uses the language server built into the CLI:

```sh
keryn lsp --stdio
```

| Editor | Setup |
|---|---|
| Zed | the Keryn extension (`keryn`), installed as a dev extension from the source with Rust installed via rustup; add `keryn` to `language_servers`. Built and unit-tested, but not yet run inside the Zed app, and not in the Zed extension registry. It has no BOM panel: Zed extensions cannot add one |
| Neovim | `vim.lsp.config('keryn', { cmd = { 'keryn', 'lsp', '--stdio' } })` (Neovim 0.11 or later) |
| Helix | a `[language-server.keryn]` entry with `command = "keryn"`, `args = ["lsp", "--stdio"]` |
| Sublime Text | the LSP package, with a `keryn` client running `keryn lsp --stdio` |
| Emacs | eglot or lsp-mode, server command `keryn lsp --stdio` |
| Kate | LSP client settings, command `keryn lsp --stdio` |

These configurations are snippets you copy by hand; none is published anywhere.

The server reads `.keryn.yml`, marks findings that are new against `base` with `[new]`, and answers a `keryn/aibom` request for editors that can show a BOM view. Plugin authors: see the [protocol](https://keryn.dev/docs/reference/lsp/).

## Warp

Keryn for Warp is four plain Warp YAML workflows (scan, AI-BOM, diff and policy check) that only run `keryn` commands; there is no Warp plugin. Install the CLI first, copy the files from `workflows/` to `~/.warp/workflows/` (or to `<repo>/.warp/workflows/` to share them through Git), and type "keryn" in Warp's workflow search. They are validated against the real CLI's flags, but have not been loaded in the Warp app, and are not published anywhere. Warp reads MCP servers from its own file; Keryn has no MCP server of its own, but see [audit and guard MCP servers](https://keryn.dev/docs/guides/mcp-guard/).

## What you just proved

The editor is the nearest place to fix a finding, and the cheapest. Every extension runs the same scan on your machine and shows the same proof level in each message, so a rung-1 lead looks like a lead before you open the file. If you set `base:` in `.keryn.yml`, the language server marks the findings that are new against it with `[new]`, which is the [delta](https://keryn.dev/docs/guides/baselines/) at the point you edit. No extension uploads code or reports telemetry; in an untrusted workspace they read file text only.

## Next

- Gate the same code in a pipeline: [CI](https://keryn.dev/docs/guides/ci/).
- Accept a finding on purpose from the quick fix: [suppressions](https://keryn.dev/docs/guides/suppressions/).
- Everything the server answers: [language server protocol](https://keryn.dev/docs/reference/lsp/).
