Staris Security Review
Run automated security reviews on your project through Staris, from your IDE.
Features
- Upload and assess through Staris: this is the full one-click end to end experience. This builds the archive, then follows ingest, context, discovery, validation, review, and reporting.
- Build a project archive from the current workspace (source, plus an optional
.staris/ configuration overlay) so you can use it in the web interface.
- Review Status progress for the run.
- Findings in the editor
- Findings sidebar (grouped by severity)
- Apply Remediations and run Playwright test repros for findings that include them.
Prerequisites
- VS Code 1.85+, Cursor, or Kiro
- A Staris Personal Access Token (PAT). Create one in Staris Workbench under Organization Settings → Personal Access Tokens. The token needs TeamAdmin privileges so it can create a project. Role details are in PATs and SSO.
Installation
Open the Extensions view (Cmd+Shift+X / Ctrl+Shift+X), search for Staris Security Review, and install the extension published by staris. The extension id is staris.staris-security-review.
Reload or restart the editor if it asks you to.
Staris adds a shield icon to the activity bar, the vertical strip of icons on the far left. Click the shield to open the Staris panel.
If the shield does not appear, open the Command Palette (Cmd+Shift+P / Ctrl+Shift+P) and run Developer: Reload Window.
VS Code
Install from the Extensions view, then click the shield on the activity bar.
Cursor
Cursor has two kinds of windows:
The Editor window is where you edit code. Its activity bar is on the far left, and the Staris shield is on that bar.
The Agents window is titled Cursor Agents. It has no activity bar, so the Staris shield is not shown and Staris commands are not available. Choose File → Open Editor Window, then File → Open Folder…, and open your project. The activity bar with the Staris Security Review shield icon should appear on the left.
Kiro
Kiro uses the same activity bar as VS Code. Install from the Extensions view, then click the shield on the far left.
First run
- Open a project folder (File → Open Folder…).
- The Staris welcome page opens. Read the Software License Agreement, check I have read and agree to the Software License Agreement, and click I Agree. Licensed features stay off until you accept. You can open the agreement again with Staris: Review License Agreement.
- Staris: Configure (Command Palette, or Configure in Staris → Review Status). Paste your PAT (see Prerequisites). If that token can create projects on more than one team, you'll need to pick the team you want the extension to use.
- Staris: Assess this Workspace from the Command Palette, or the shield icon → Staris → Review Status → Assess this workspace.
If you only want to run a subset of the security review skills, use Choose skills. Create and upload project packages and uploads the archive without starting a run, so you can interact with the project using the web interface.
Usage
Watch the run in:
- Staris → Review Status — stages in order: Build and upload project archive, Ingest, Context, Discovery, Validation, Review, Report
- The progress notifications
- View → Output → Staris Security Review
| Indicator |
Meaning |
| Gray |
Pending |
| Pulsing red |
In progress, or waiting on a Workbench approval gate |
| Green |
Completed or skipped |
| Solid red |
Failed (the error is shown under the list) |
A waiting stage names the gate. Release that gate in Staris Workbench. This extension cannot release it.
When the run finishes, findings show in the Problems panel. Refresh findings from Staris (Review Status, or Staris: Refresh Findings) pulls the latest findings without uploading again. Staris: Open Latest Report opens the downloaded report.
Staris: Attach to Staris Project binds this folder to an existing Staris project. Staris: Pull Findings and Patches downloads that project's findings and patches.
Logging
| Destination |
Location |
| Output panel |
View → Output → Staris Security Review |
| Developer console |
Help → Toggle Developer Tools → Console |
| Log file |
.staris/logs/{projectName}-{YYYY-MM-DD-HHmmss}.log |
staris.logging.level is debug, info, warn, or error. staris.logging.fileEnabled writes the log file (default: on).
Troubleshooting
The extension does not load
- Open the Command Palette and run Developer: Reload Window. In Cursor, do this in an Editor window. The Agents window has no activity bar, so the shield will not appear there. See Cursor.
- Extensions view → search Staris Security Review → confirm it is enabled, and that the publisher is staris.
- If the editor shows Restricted Mode, open Manage Workspace Trust and choose Trust.
- View → Output → Staris Security Review should include
Staris extension activated. If activation failed, open Log (Extension Host).
Cursor: Staris commands are missing
You are likely in Cursor's Agents window. That window has no icon strip on the left, so Staris commands are not listed. Choose File → Open Editor Window, then open your project folder. Cmd+Shift+P → Staris: Configure.
The extension did not finish activating. Check View → Output → Extension Host. Then reinstall Staris Security Review from the Extensions view and run Developer: Reload Window. In Cursor, use an Editor window. Trust the folder if the editor asks.
Git history in the project archive
The workspace .git directory is uploaded so remediations can refer to commits and branches. Only a sanitized copy is included:
- Included:
HEAD, index, packed-refs, shallow, objects/, refs/, reftable/, and a regenerated config
- Regenerated
config: only core repository-format keys, extensions, remote.*.url / pushurl / fetch, branch.*, and submodule.*.url / active / branch. Credentials in remote URLs (https://token@host/..., https://user:pass@host/...) are removed
- Never included: hooks, reflogs (
logs/), [credential], [http] extra headers, url.*.insteadOf rewrites, [user], [include], FETCH_HEAD, COMMIT_EDITMSG, and a workspace-root .git-credentials
- Linked worktrees and submodule checkouts (where
.git is a gitdir: pointer file) are stored as a normal standalone .git directory
If a remote URL contained an embedded token, the review shows a warning. That token is still in your local .git/config in plain text, so rotate it and use a credential helper.
Nested .git directories (for example vendor/lib/.git) follow staris.excludePatterns and are sanitized the same way when they are included.
Optional: project archive configuration overlay
Put Staris test configuration next to the project under .staris/:
.staris/
├── config/
│ ├── creds/ # API credentials JSON files
│ └── env/ # Test environment JSON files
├── docs/
│ ├── policy/ # Security policies
│ └── product/ # API docs, specs
├── scope/ # Threat models, scope definitions
└── logs/ # Review log files (auto-created)
See the Project Archive description in the Staris documentation for more details.
Before the archive is built, a configuration check looks for missing credentials, environment files without target URLs, invalid JSON, and similar gaps. If something important is missing, a prompt offers Edit Files (opens .staris/ files, with scaffolds for common templates), Continue Anyway, or Cancel Review.
Settings
| Setting |
Description |
staris.personalAccessTokenStatus |
Read-only: Configured or Not configured |
staris.teamId |
Team for new projects (set by Staris: Configure) |
staris.projectId |
Reuse an existing project (optional) |
staris.projectName |
Name for new projects (generated when empty) |
staris.testEnvironment |
Test environment name for validation |
staris.minSeverity |
Minimum severity for report generation |
staris.pollIntervalSeconds |
Seconds between status polls |
staris.excludePatterns |
Glob patterns excluded from the project archive src/ |
staris.logging.level |
Minimum log level: debug, info, warn, error |
staris.logging.fileEnabled |
Write logs to .staris/logs/ (default: on) |
Commands
| Command |
Description |
Staris: Assess this Workspace |
Upload and start an assessment |
Staris: Choose Skills |
Pick assessment skills before upload |
Staris: Create and Upload Project |
Upload a project archive without starting an assessment |
Staris: Run All Playwright Repros |
Run every spec under .staris/repros/ (trusted workspace) |
Staris: Cancel Review |
Cancel the in-progress review |
Staris: Refresh Findings |
Re-fetch findings for the latest completed review |
Staris: Attach to Staris Project |
Bind this workspace to an existing Staris project |
Staris: Pull Findings and Patches |
Download findings and patches for the bound project |
Staris: Configure |
Save a PAT and choose a team |
Staris: Clear Personal Access Token |
Remove the stored PAT from this editor |
Staris: Clear Findings |
Clear diagnostics and the sidebar |
Staris: Open Latest Report |
Open the latest report under .staris/reports/ |
Staris: Review License Agreement |
Open the license welcome page |
Files you may want to .gitignore
.staris/*.json
.staris/review-summary.md
.staris/logs/
License
The Staris Security Review extension is licensed under the Software License Agreement shipped with the extension as LICENSE.md (SEE LICENSE IN LICENSE.md). Accept that agreement in the editor before using the extension.
The @staris/mcp server is a separate package under the MIT License. See @staris/mcp on npm.