1
Install it
- VS Code and forks
- JetBrains IDEs
Press
Ctrl+Shift+X (or Cmd+Shift+X), search for Iris Code, and click Install. Its icon appears in the Activity Bar, the strip of icons down the side of the editor; click it to open the sidebar.The same search works in Cursor, Windsurf, VSCodium and Trae, which install the identical build from Open VSX. You can also install the .vsix file manually.Every editor uses the same checks underneath, so a file gets the same score and the same findings wherever you open it.
2
Open a supported file
Open a JavaScript, TypeScript, Vue, Svelte, Go, Python, Ruby, C#, Java or Rust file. Iris Code scores it automatically; you do not need to run anything.Open Review → File. The File tab shows:
- A readiness summary - the score, the number of blockers, whether a hook is installed and how the score has changed over time
- The health score - 0 to 100, recalculated every time you save
- Blockers and warnings - click one to jump to its line in the file
- Every function - with its length and complexity, meaning how hard it is to follow
- Code smells - patterns that make mistakes more likely, such as TODOs, magic numbers, debug prints, unused variables and long parameter lists
3
Run your free workspace scan
Open the command palette (
Ctrl+Shift+P / Cmd+Shift+P) and run Iris Code: Scan Workspace. The workspace is the project folder open in your editor.Iris Code checks every supported file and fills in:- Workspace readiness - one score for the whole project, with blocker and warning counts
- Hotspots - the largest and most complex files, ranked first
- Findings tab - every blocker and warning in one list you can filter
- TODOs tab - every TODO, FIXME and HACK comment in the project
That first result is a snapshot of the project at the moment you scanned it.After it, each new workspace or folder scan uses one local project action, if your account has an allowance. Opening findings, TODOs, maps or reports you already have does not use another one.
- Hooks, builds and CI enforcement need a paid plan.
- The package guard, which checks packages before a coding agent installs them, stays Free.
- Verification that comes with a refactor plan you already have stays Free.
4
Preview what would be blocked
At the bottom of the File tab, click Preview Gate. Iris Code scans the project in the background and shows how it scores against all six presets. A preset is a ready-made set of standards.
Each card shows how many files would be blocked at that minimum score. Apply saves your choice as
presetId in .irisconfig.json, the project’s settings file, without opening it.Preview Gate is free and changes nothing. No hook is installed and no file is blocked until you turn blocking on yourself. Pro adds the list of which files fail each preset, and by how much.
5
Install the CLI (optional)
The CLI is the set of Iris Code commands you type in a terminal. Use it to scan, to check code in CI (the automated checks that run after a push) or to audit your packages without opening an editor:The CLI runs the same checks as the extension, so it uses the same thresholds.
iris check <file> scores a single file, and iris gate is the command to use in CI.Where to go next
Block weak code
A pre-push hook stops anything below your threshold before it reaches the shared repository.
Share your thresholds
Commit one
.irisconfig.json so the whole team is checked against the same rules.Enforce in CI
Run
iris gate in your pipeline, with comments on the affected lines of a GitHub pull request.Try Pro
An optional 14-day trial, with no card, to try paid blocking and project workflows. Signing in does not start it automatically.