Getting started · 5 steps · ~15 min

Up and running with Iris Code.

A walkthrough from installation to enforcement. Follow the steps in order — the whole thing takes about 15 minutes.

01free2 min

Install the extension.

Search "Iris Code Health" in the Extensions panel (Ctrl+Shift+X / Cmd+Shift+X), or use the direct Marketplace link below. On a JetBrains IDE, search "Iris Code" in Settings → Plugins and restart the IDE after installing. Iris Code activates automatically when you open a JavaScript, TypeScript, Go, or Python file.

Iris Code — Code Health

marketplace.visualstudio.com · davidjaja.iris

Install
02free1 min

Open a file. See results.

Click the Iris Code icon in the Activity Bar to open the sidebar. Then open any .ts, .tsx, .js, .jsx, .go, or .py file. You'll see the health score, function list, complexity score, and any code smells or import issues in real time.

Iris Code · Health⟲ ⋯
checkout.ts· src/orders
52/ 100▼ 6 this week
050100
Blockers · 2
Cyclomatic complexity above thresholdprocessOrder() · cx 24 / limit 15L 84
Function exceeds max lengthvalidatePayment() · 92 lines / limit 60L 142
Functions · 7
processOrder · L84cx 24High
validatePayment · L142cx 16Med
applyDiscount · L48cx 9Med

The Iris Code sidebar — populated the moment you open a supported file.

See what Iris Code analyses
03free2 min

Sign in from your editor.

In VS Code, open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P) and run "Iris Code: Sign In" - your browser opens, authenticates, and redirects back with your license key, stored securely in VS Code's SecretStorage. In a JetBrains IDE, use Tools → Iris Code → Sign In; the key is stored once under your home directory and shared with the iris CLI, so one sign-in covers every host. No copy-pasting.

Back to your dashboard
04free5 minManual step

Configure your project.

Open Account -> Config in your dashboard to pick a preset and sync a .irisconfig.json to VS Code or a JetBrains IDE without touching a file manually. Free users can apply any preset (balanced, strict, legacy, security, typescript) and commit it so the whole team uses the same thresholds. Pro users get the full Config Studio - switch to Custom mode to override individual thresholds, retention controls, toggles, and severity rules.

This step is not auto-detected yet. We'll add real completion tracking once Iris Code exposes reliable setup signals for configuration and enforcement.
.irisconfig.json
{
  "presetId": "balanced",
  "minHealthScore": 75,
  "complexityThreshold": 8,
  "functionLengthThreshold": 60,
  "trendRegressionThreshold": 5,
  "gateBaselineMode": true,
  "enableSecretsDetection": true,
  "gateMaxSecrets": 0,
  "ignoreFiles": [
    "**/*.test.ts",
    "**/generated/**"
  ]
}
Full configuration reference
05free1 minManual step

Give your AI agent the rules.

Run "Iris Code: Write Project Rules for AI Agents" from the Command Palette, or `iris rules` in a terminal. It turns your .irisconfig.json into instructions - file and function limits, your naming convention, what blocks a push - and writes them to AGENTS.md, CLAUDE.md, Cursor rules or Copilot instructions. Pick more than one if your team runs more than one agent: Claude Code reads only CLAUDE.md, while AGENTS.md is what Codex, Cursor and Copilot read. Nothing is analysed, nothing leaves your machine, and no AI model is involved. Commit the file so it applies to everyone, and every agent, working in the project.

This step is not auto-detected yet. We'll add real completion tracking once Iris Code exposes reliable setup signals for configuration and enforcement.
Project rules documentation
06pro5 minManual step

Set up enforcement gates.

Before installing a hook, open Gate Preview from the bottom of the File tab - it shows how your workspace scores against all six preset thresholds for free, with no enforcement. Once you're confident in the threshold, run "Iris Code: Install Git Hook" from the Command Palette. A build hook for npm prebuild, Go Makefile, and Python projects is also available.

This step is not auto-detected yet. We'll add real completion tracking once Iris Code exposes reliable setup signals for configuration and enforcement.
Terminal — git push origin main
$ git push origin main
Iris Code: Checking health score...
✗ src/utils/format.ts — score 61 (threshold: 75)
Iris Code: Push blocked. Fix failing files or lower your threshold.
error: failed to push some refs to 'origin'
Enforcement documentation
Enforcement gates require Iris Code Pro.
Plan comparison

Free vs Pro

Iris Code is genuinely useful on the Free plan. Pro adds the features that matter for teams — enforcement, workspace analysis, and shared configuration.

Free

$0

Always free, no credit card

Pro

$6/mo

Cancel any time

File analysis (health score, complexity, functions)
TypeScript metrics
Code smell detection
Security smell detection (eval/exec, SQL injection, insecure RNG, and more)
Hardcoded secrets detection
Inline diagnostics (squiggles + Problems panel)
Status bar + Code Lens
JS, TypeScript, Vue/Svelte scripts, Go, Python, Ruby, C#, Java, and Rust support
Detached panel & HTML report export
Health score trend tracking (2 snapshots)
.irisconfig.json preset configs (presetId)
Gate Preview (read-only enforcement posture check)
iris check: single-file health scan from the terminal (CLI)
iris secrets: hardcoded credential scanner, no auth required (CLI)
iris security: eval usage, SQL injection, weak hashing, and more, no auth required (CLI)
Project rules for AI agents: write your standards where Copilot, Cursor, or Claude read them
iris report: standalone HTML health report (CLI)
iris hook status: check hook installation state (CLI)
iris config init and validate (CLI)
14-day trial available by request - no credit card required
Everything in Free
Workspace analysis
Folder analysis
Gate Preview drilldown - see exactly which files fail each preset
Git hook enforcement
Build hook enforcement
Dependents table (version audit + CVE scan)
Issues tab with blocker and warning filters
TODOs tab aggregation
Clickable jump-to-line on all findings
.irisconfig.json custom config (threshold overrides)
Retention controls - regression threshold + baseline mode
Custom enforcement limits - block on secret count, complexity ceiling, file size, smell density, or security smell count
Custom health score weights per finding type
Config Studio - build, preview, and sync to VS Code
Unlimited trend history + trends table
iris gate: full enforcement gate for CI pipelines (CLI)
iris deps: dependency and CVE audit (CLI)
iris cve: fail CI only on CVEs at or above a severity threshold (CLI)
iris sbom: CycloneDX 1.5 SBOM export (CLI)
iris todos: aggregate TODO and FIXME comments (CLI)
iris hook install and uninstall (CLI)
iris check: directory and staged file scans (CLI)
Push-blocked counter - monthly and total pushes blocked, with health score delta since Pro activation
All done?

You're ready to ship better code.

Open VS Code or your JetBrains IDE, install Iris Code, and it will be in your sidebar the next time you open a file.

Catch regressions before human review

Install Iris Code, set a threshold, and make every change answer to the same deterministic rules. Source analysis runs locally. The same rules run in VS Code, JetBrains IDEs, the iris CLI, hooks, and CI.

VS CodeCursorWindsurfVSCodiumIntelliJ IDEAWebStormPyCharmGoLandVS CodeCursorWindsurfVSCodiumIntelliJ IDEAWebStormPyCharmGoLand