Skip to main content
Most people should install Iris Code from their editor’s marketplace. It keeps Iris Code up to date automatically and needs no extra steps. The other routes are for specific situations: a downloaded .vsix file when a machine cannot reach a marketplace, and npm when you want the CLI, the Iris Code commands you type in a terminal or run in CI. Every route uses the same checks, so a file gets the same score in each. One sign-in covers your editors and the CLI together.

VS Code

Listing: marketplace.visualstudio.com.
1

Open Extensions

Press Ctrl+Shift+X on Windows and Linux, or Cmd+Shift+X on macOS.
2

Search Iris Code

Look for the extension published by davidjaja.
3

Install

VS Code downloads and starts it immediately. No restart is required.
4

Confirm the install

The Iris Code icon appears in the Activity Bar, the strip of icons down the side of the editor. Open a file in a supported language and the sidebar fills in, with no setup.

Cursor, Windsurf, VSCodium, Trae

These editors install extensions from Open VSX rather than the Visual Studio Marketplace. Iris Code publishes the identical build to both, so installing from inside the editor works the same way and updates still arrive automatically. Open the Extensions panel, search for Iris Code, and click Install.
You do not need the manual .vsix route for these editors. Use it only if your machine cannot reach a marketplace at all.

Installing from a file

Use this route on a machine with no internet access or with locked-down installs, or when you need a specific version. Download: iriscode.co/downloads/iris-code.vsix Install it from the Extensions panel, using the ⋯ menu → Install from VSIX…, or from the command line:
Installing from a file means no automatic updates. You have to download and install each new version yourself.

JetBrains IDEs

Works in IntelliJ IDEA, WebStorm, PyCharm, GoLand, PhpStorm, Rider, RubyMine, CLion and Android Studio. Listing: plugins.jetbrains.com.
1

Install LSP4IJ first

Open Settings → Plugins → Marketplace, search for LSP4IJ, and install it. LSP4IJ is a free plugin that Iris Code uses to connect the IDE to its checks.The Marketplace installs LSP4IJ for you when you install Iris Code. Installing Iris Code from a file does not, and Iris Code will not load without LSP4IJ.
2

Install Iris Code

In the same Marketplace tab, search for Iris Code and click Install.
3

Restart the IDE

Restart the whole IDE rather than only reloading the plugin.JetBrains registers which program handles each type of file only at startup. After a reload alone, the IDE handles .irisconfig.json incorrectly.
4

Confirm the install

Open a supported file. Findings appear as squiggly underlines, and the Iris Code tool window on the right shows the full panel. Sign in from Tools → Iris Code → Sign In.

JSON standard does not allow comments

If .irisconfig.json shows this error, your IDE has saved a setting of its own that cancels the file type Iris Code registers for it. Iris Code writes .irisconfig.json with a comment beside each setting, so the file explains itself. Plain JSON does not allow comments, so Iris Code tells the IDE to treat the file as JSON5, which does. When a plugin that registers a file type is uninstalled, IntelliJ saves a permanent setting cancelling that registration. Updating Iris Code by uninstalling and reinstalling it is enough to create that setting. The setting lives in your IDE settings rather than in the plugin, which is why reinstalling, updating and restarting will not clear it. Add the pattern back by hand:
1

Open the file type settings

Go to Settings → Editor → File Types.
2

Select JSON5

Choose JSON5 in the Recognized File Types list.
3

Add the pattern back

Under File name patterns, click +, enter .irisconfig.json, then click OK and Apply. If the IDE warns that the pattern was previously removed, accept it: that clears the saved setting. No restart is needed.
You can edit the file directly instead. Close the IDE completely, remove the line <removed_mapping pattern=".irisconfig.json" approved="true" type="JSON5" /> from filetypes.xml in your IDE’s configuration directory, then reopen it. Close the IDE first, because a running IDE rewrites that file when it exits.
Do not try to fix this under Settings → Languages & Frameworks → Schemas and DTDs. That screen links files to JSON schemas, which describe what settings a file may contain. It does not set file types, and JSON5 never appears there. Iris Code configs already carry a $schema line, so no manual entry is needed.

The CLI

The CLI runs scans, gate checks and dependency audits from any terminal or CI pipeline, with no editor involved.
The CLI needs Node.js 18 or later. Check your version with node --version. Very new Node releases are sometimes ahead of the tools that support them, so a long-term support (LTS) release is the safer choice.

System requirements

Languages: TypeScript, JavaScript, Vue, Svelte, Go, Python, Ruby, C#, Java and Rust. The full list of file extensions and caveats is in Supported languages. You do not need to install any other language tools, compilers or runtimes. Iris Code reads and checks your files itself, without running them.