Running one
Run Iris Code: Scan Workspace from the command palette, or open Review → Workspace and use Scan Workspace. It reads every supported file and gives you:- Readiness - the overall score, blockers, warnings, how many TODOs there are and which way the score is moving
- The totals - files, directories, lines, functions
- A language breakdown
- Hotspots - the five biggest files and the five most complex
- Unused packages - declared in
package.json,go.mod,requirements.txtorpyproject.toml, never imported - A CVE badge on the Dependencies section. A CVE is a known security vulnerability in a package. The badge is green when the last saved dependency scan found nothing, and otherwise shows the count and the worst severity. It reads the saved results only and never goes to the network on its own. See Dependents Table
- Findings - every blocker and warning in one list
- TODOs - grouped by type
- A file tree you can click through
- Trends - the score change plus your three most improved and three most regressed files
A saved result is a record of one scan. It keeps the files it covered, the settings used, when it ran and what it covered, and it does not change when your files change later. Opening it does not refresh it.Starting a fresh scan can use one local project action. Free allowances explains when a result is reused, what happens when your allowance runs out, and reading results offline.
Just one folder
Right-click any folder in the Explorer and pick Iris Code: Scan This Folder. Or select Scan Current Folder in the Folder tab to scan the folder that contains the open file. The Folder tab shows the same stats, chart, rankings and tree as the workspace, with its own Rescan and Clear.Basic file checks stay Free. Signed-in Free users can run fresh workspace, folder and changed-file scans within their monthly project allowance. A completed scan that produces a usable result uses one action; opening its views does not use another. Pro adds unmetered local scans where they apply, and enforcement that stops a push or build automatically.
Scanning again
If nothing that affects a scan has changed, Iris Code can show the result you already have without using another local action. A fresh scan is needed when any of these change:- your source files
- the settings in effect
- what is being scanned
- the Iris Code analysis engine
- the baseline, a saved starting point used for comparison
Findings and TODOs
Both tabs fill from your most recent scan, whether that was a folder or the whole workspace. A label at the top tells you which (“Showing: folder · src”), with one click back to the whole workspace, so you always know whether you are reading folder results or project results. Each row gives you a severity dot, the file and line, and what’s wrong. Click it to go to that line. The Findings badge shows errors in red, or the total when there are none. The TODOs badge counts everything. Findings stay until you rescan or clear.Trends
Open Trends to compare saved whole-workspace scans. These saved scans stay available after your allowance runs out or paid access ends. Opening a comparison does not scan your current files or use another action. Choose two scan times to see how each file’s score changed. Each saved scan keeps the settings and the exact build of the Iris Code analysis engine it used. If either differs between the two, the comparison warns you: a score change can come from a different standard, not just from a code change. Folder and changed-file scans are not included in whole-workspace trends. Saved scans are private to the account that ran them and to that workspace. Sign in to that account to reopen them. Once that account has been confirmed online on this machine, its earlier results can be read offline. Older trend files are still supported:- They live in
.iris-snapshots/at your project root, which is added to.gitignore. - Older scans update one snapshot per day. Free keeps two rolling snapshots; Pro keeps the full rolling history.
- Clear trend files removes those rolling snapshots and the locked baseline. It does not delete your private saved scans.
- Locking a baseline so a regression blocks automatically remains a paid feature.
Sharing a report
A completed workspace scan can be shared as a summary card or a PDF report. Select the download icon in the Iris Code sidebar header, or run Iris Code: Share Report from the command palette, to open the export options. The card leaves out file paths, source code and secret values, so it is safe to post or attach to a pull request. Shareable scan reports explains each format and what the numbers mean. From the terminal:iris-report.html to the current directory, and --output <path> chooses a different destination. Scanning a directory fresh uses your project access. To export a saved result without scanning again, add --evidence <evidence-id>, where the evidence ID identifies that saved scan.
You can also share a saved scan as a card or PDF. Saved exports remain available after your allowance runs out or paid access ends.