# Iris

## Docs

- [Iris Changelog: VS Code Extension and CLI Release Notes](https://docs.iriscode.co/changelog.md): Full release notes for the Iris VS Code extension and @iris-code/cli npm package. Updates ship automatically through the VS Code Marketplace.
- [Authenticate the Iris CLI with Browser or Token](https://docs.iriscode.co/cli/auth.md): Sign in to Iris CLI via browser OAuth for local development, or use IRIS_LICENCE_TOKEN for non-interactive CI runners. Credentials stored in ~/.iris/credentials.
- [Use Iris in CI Pipelines: GitHub Actions, GitLab, and Shell](https://docs.iriscode.co/cli/ci.md): Run iris gate as a CI enforcement step in GitHub Actions, GitLab CI, or any shell pipeline. Pass your licence via IRIS_LICENCE_TOKEN and fail builds that miss the threshold.
- [Iris CLI Command Reference](https://docs.iriscode.co/cli/commands.md): Full reference for all nine Iris CLI commands: iris check, iris secrets, iris deps, iris todos, iris gate, iris report, iris hook, iris auth, and iris config.
- [Iris CLI: Code Health Enforcement from the Terminal](https://docs.iriscode.co/cli/overview.md): The @iris-code/cli package brings Iris health analysis to any terminal, build script, or CI pipeline. Nine commands cover scanning, gating, secrets, deps, and hooks.
- [Config Studio: Build and Sync Your Iris Config Visually](https://docs.iriscode.co/configuration/config-studio.md): Config Studio is a visual editor in your account dashboard. Pick a preset, tune thresholds, and sync the resulting config to VS Code with a diff preview.
- [Configure Iris with .irisconfig.json — Presets and Rules](https://docs.iriscode.co/configuration/irisconfig.md): Drop a .irisconfig.json at your project root to share thresholds across your team. Covers presets, custom thresholds, gate limits, and severity overrides.
- [Custom Scoring Weights: Tune the Health Score for Your Team](https://docs.iriscode.co/configuration/scoring-weights.md): Control how much each finding deducts from the health score via healthScoreWeights in .irisconfig.json. Amplify secrets, zero out noise. Requires Iris Pro.
- [Iris VS Code Settings Reference — All iris.* Options](https://docs.iriscode.co/configuration/vscode-settings.md): All iris.* settings available in VS Code's settings UI (Ctrl+,). Configure thresholds, detection toggles, and display options per machine.
- [Build Gate: Block Builds That Fall Below Your Threshold](https://docs.iriscode.co/enforcement/build-gate.md): Install the Iris build hook to run a health check before every build. Builds that fall below your configured threshold are stopped before compilation.
- [Dependents Table: Audit npm, Go, and Python Packages](https://docs.iriscode.co/enforcement/dependents-table.md): Open the Dependents Table in VS Code to audit every package for outdated versions and CVEs from the GitHub Advisory Database. Requires Iris Pro.
- [Gate Preview: Check Your Enforcement Posture for Free](https://docs.iriscode.co/enforcement/gate-preview.md): Gate Preview runs a read-only workspace scan against all five built-in presets so you can see how many files would be blocked before enabling any hook.
- [Git Hook: Block Weak Code Before It Leaves Your Machine](https://docs.iriscode.co/enforcement/git-hook.md): Install Iris's git pre-push hook to automatically block any push where a file scores below your configured health threshold. Requires Iris Pro.
- [GitHub Actions: Block Merges With Iris CI Enforcement](https://docs.iriscode.co/enforcement/github-actions.md): Add Iris to GitHub Actions to block merges when files fall below your threshold. Get inline PR annotations at failing lines. Requires Iris Pro.
- [Hardcoded Secrets: Two-Layer Credential Detection in Iris](https://docs.iriscode.co/enforcement/hardcoded-secrets.md): Iris scans every file for leaked credentials using two detection layers: suspicious variable names and known token formats. Each finding deducts 10 points.
- [Inline Diagnostics: Squiggles and Problems Panel Entries](https://docs.iriscode.co/enforcement/inline-diagnostics.md): Opt in to surface Iris findings as editor squiggles and Problems panel entries. Off by default to keep the Problems panel clean. Configure per-category.
- [Editor Integration: Code Lens, Status Bar, and Panel](https://docs.iriscode.co/features/editor-integration.md): Iris integrates into VS Code with inline Code Lens hints above functions, a live health score in the status bar, and a detachable full-panel analysis view.
- [File Analysis: Health Scores, Code Smells, and Secrets](https://docs.iriscode.co/features/file-analysis.md): Iris analyses every file on open and save: 0–100 health score, complexity, function list, code smells, TypeScript metrics, and secrets detection.
- [Supported Languages: TypeScript, JavaScript, Go, Python](https://docs.iriscode.co/features/language-support.md): Iris natively parses and scores TypeScript, JavaScript, Go, and Python with per-language function detection, import tracking, and debug-print flagging.
- [Workspace and Folder Analysis: Aggregate Scores and Trends](https://docs.iriscode.co/features/workspace-analysis.md): Scan your entire project or any folder for aggregate metrics, ranked hotspots, unused packages, blocking issues, TODO comments, and health trend tracking.
- [Install Iris: VS Code Extension and CLI Setup Guide](https://docs.iriscode.co/installation.md): Install Iris Code from the VS Code Marketplace or as a .vsix file in Cursor, Windsurf, or VSCodium. CLI available via npm for terminal and CI use.
- [Iris: Code Health Scores, Smells, and Gate Enforcement](https://docs.iriscode.co/introduction.md): Iris scores every file on save, flags secrets and smells in the sidebar, and blocks pushes below your threshold. No code upload, no AI, no backend.
- [Iris Pro: Workspace Scans, Hooks, and Full Enforcement](https://docs.iriscode.co/pro.md): Iris Pro adds workspace scans, git and build hook enforcement, dependency CVE audits, custom config weights, and the full CLI suite. 14-day free trial.
- [Quick Start: Install Iris, Scan Files, and Preview Gates](https://docs.iriscode.co/quickstart.md): Install Iris Code in VS Code, run your first file analysis, and preview your enforcement posture — from zero to first scan in two minutes.
- [Iris VS Code Command Palette and Context Menu Reference](https://docs.iriscode.co/reference/commands.md): All Iris commands available via the VS Code command palette (Ctrl+Shift+P) and right-click context menus in the Explorer and editor.
- [Health Score and Complexity: How Iris Scores Your Code](https://docs.iriscode.co/reference/scoring.md): Iris calculates a 0–100 health score and a 1–10 complexity score per file. Health starts at 100 with points deducted per finding type.