Running a Workspace Scan
Run Iris: Analyse Workspace from the command palette (Ctrl+Shift+P) or click the Scan Workspace button in the Iris Workspace tab. Iris will walk every supported file in your project and return:
- Workspace Readiness summary — top-level score, blocker count, warning count, TODO load, and trend posture
- Aggregate counts — total files, directories, lines, and functions across the workspace
- File type breakdown — a breakdown of files by language
- Ranked hotspots — largest files (top 5) and most complex files (top 5)
- Unused packages — packages declared in
package.json,go.mod,requirements.txt, orpyproject.tomlbut never imported - Issues tab — blocking issues and warning-level findings aggregated in one place
- TODOs tab — all TODOs, FIXMEs, and HACKs aggregated and grouped by type
- Interactive file tree — all scanned files grouped by directory
- Trend summary — overall score delta plus the top 3 improved and top 3 regressed files since the last snapshot
Folder Analysis
To analyse a specific part of your project, right-click any folder in the VS Code Explorer and choose Iris: Analyse This Folder. Alternatively, click Scan Current Folder in the Iris Folder tab to analyse the folder of the file you currently have open. Results appear in the dedicated Folder tab, which activates automatically when a scan completes. The Folder tab shows the same stats, file type pie chart, ranked files, and interactive file tree as the Workspace tab, plus Rescan and Clear buttons for that folder.Workspace Analysis and Folder Analysis require a Pro subscription. File
analysis and single-file scoring are available on the Free plan.
Issues & TODOs Tabs
The Issues and TODOs tabs populate from the most recent folder or workspace scan. Each row shows:- A severity indicator (colour-coded dot: red for errors, yellow for warnings)
- The filename and line number where the issue occurs
- A short message describing the finding
- The Issues tab badge shows the error count in red, or the total issue count when there are no errors
- The TODOs tab badge shows the total count of TODO / FIXME / HACK items found
- Readiness cards in the File, Folder, and Workspace tabs include quick-jump links into the Issues and TODOs tabs
- Findings persist until you run a new scan or click Clear
Trend Tracking
Iris saves a daily health-score snapshot for each file after a workspace scan. Over time, these snapshots reveal whether your codebase is improving or regressing.Where trends appear
- File analysis — a ↑/↓ delta appears next to the health score, comparing the current score against the previous snapshot
- Workspace analysis — after each scan you see the overall score delta, a list of the top 3 improved files, and a list of the top 3 regressed files
How snapshots work
- Iris saves one snapshot per day — running multiple scans on the same day updates the existing snapshot rather than creating a new one
- Snapshots are stored in
.iris-snapshots/at your workspace root .iris-snapshots/is automatically added to your.gitignore— snapshots are local to each developer and are not committed- To reset your trend history, delete the
.iris-snapshots/folder
Export Report
Save your current analysis as a standalone, dark-themed HTML file you can share with your team, attach to a pull request, or keep as an archive.Open the command palette
Press
Ctrl+Shift+P (or Cmd+Shift+P on macOS) and run Iris: Export Scan Report as HTML.Choose a save location
Pick where to save the file. The default filename is
iris-report.html in your workspace root.- File analysis — health score, warnings table, and functions table for the currently analysed file
- Workspace analysis — summary stats grid, top files by health score, and file type breakdown
- Folder analysis — scoped results for the selected folder
iris-report.html in the current directory by default. Pass a path argument to save elsewhere.
Export is available on all plans — no Pro subscription is required. The
report is a static snapshot; re-run your analysis and re-export to get
updated data.