Documentation

Authorize every action your AI agents take

Use the editor extension to inspect code and agent settings. These guides explain how to install it, read the results, sign in, and choose your next step.

Choose what you want to check

Code review, account access and runtime protection are different tasks. A review reports what it can inspect; it does not automatically enforce a policy.

01

Code review

Inspect code findings in the editor. Check the location and context before deciding what to change.

02

Agent environment

Review supported agent configurations and the permissions they describe. Unknown or unreadable settings are not proof of safety.

03

Your account

Sign in for your account and plan. Free sign-in does not require checkout or a payment card.

04

Corrections

Review a proposed correction before applying it. Copying a fix prompt does not change a file.

05

Protection

Protection needs a specific configuration you choose to apply. Running a review does not intercept every agent action.

06

CI review

Check supported agent configurations on your runner. Choose a posture threshold if you want the Action to fail a job.

Go deeper

Understand permissions and the limits of a review.

Install

There are two ways to run DeepSweep, and both are apps you open rather than commands you type.

Studio (desktop)

Open a project folder in Studio to review supported agent configurations. Use the download page to check available builds and their checksums.

Studio is available for macOS. Download it, with each build's SHA-256 checksum beside it. The Windows and Linux builds are not out yet.

Editor extension

Code and agent-configuration reviews in your editor. In Antigravity, Kiro, Devin (formerly Windsurf), code-server, VS Code and VSCodium, search DeepSweep in the Extensions panel — and if it isn't there, follow the package instructions for your editor. Cursor does not list DeepSweep in its own extension search yet, so start with the package there. In Trae, its extension search still offers an older DeepSweep build, so use the package there to get the current one. Start the guided install. Reviews run locally; account access and other network-backed features are explained in Configuration.

Run a review

  1. Open your project folder. In the editor Command Palette (Ctrl+Shift+P / Cmd+Shift+P), choose DeepSweep: Review Workspace for code findings or DeepSweep: Review My Agent Environment for supported agent settings.
  2. Inspect each finding before making a change. A pattern match is a reason to look, not proof of an exploitable vulnerability. Copy Fix Prompt is available without signing in. It copies text for your coding assistant; it does not edit the file.
  3. Review the changed file again. If the workspace result says it is incomplete, choose DeepSweep: Review the Remaining Files. A partial review is not a clean bill of health.

Connect your account

Local review does not require an account. Signing in is free and does not require checkout or a card. Choose DeepSweep: Sign In or DeepSweep: Sign In with Code in the editor. On the activation page, check the code and account before approving. Return to the editor and use DeepSweep: Show Account to confirm the connection.

If the code expires or the browser does not open, follow the sign-in recovery steps. A browser sign-in and an editor connection are separate steps. Opening or cancelling an upgrade checkout does not activate a paid plan.

CI/CD

Review supported agent configurations on pull requests. The Action bundles its engine, sets up Node, and runs on your runner. The pull-requests: write permission is what lets the Action post the result on the pull request. Comments are enabled by default; set comment-on-pr: false to disable them. Fork pull requests may have a read-only token.

.github/workflows/deepsweep.yml
name: DeepSweep
on: [push, pull_request]

permissions:
  contents: read
  pull-requests: write

jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Agent Environment Review
        uses: deepsweep-ai/action@v1
        with:
          path: .

To turn the review into a merge gate, add fail-below-score. It takes the posture score, 0–100. The job fails when the score is under the number you set, and also when there is no agent configuration in the repository to score — a threshold that cannot be evaluated is never quietly treated as a pass.

Pick the number deliberately, because it decides how often the build goes red. The bands are weak below 40, fair to 69, good to 89 and strong above that. Starting at 40 blocks only genuinely weak posture, which is the useful signal on a repository nobody has hardened yet. Raise it to 70 once the team has closed its gaps and wants to hold the line at good.

.github/workflows/deepsweep.yml — with a merge gate
      - name: Agent Environment Review
        uses: deepsweep-ai/action@v1
        with:
          path: .
          fail-below-score: 70

Detection patterns

The editor checks code and agent settings for credential exposure, suspicious instructions, risky MCP configuration and application-security patterns. The loaded checks depend on the installed version and the files reviewed.

Studio and the GitHub Action review agent configurations and report capabilities and inferred gaps. Their posture score is different from the editor code-review grade. Inspect reviewed sources and warnings; an unreadable configuration is not evidence of no access.

Read how to interpret findings.

Supported AI assistants

Supported configuration formats vary by product and release. An Agent Environment Review lists the sources it inspected and warns when a source could not be read. Check that list for your assistant rather than assuming every configuration on the machine was covered.

The installation guide lists the editors the extension installs in.

Configuration

Usage telemetry

Turn off deepsweep.telemetry.enabled in editor Settings to stop extension usage telemetry. With telemetry enabled, usage can be associated with your signed-in account identifier. Turning telemetry off does not turn off sign-in or other network-backed features.

Offline review

DEEPSWEEP_OFFLINE=1 in the editor extension host's environment disables the extension's network-backed features while local review remains available. It does not control your browser, editor, other extensions or Studio. See Configuration for the distinction between telemetry opt-out and offline mode.

Review settings and CI

Editor settings control automatic review and remediation. The GitHub Action has a separate fail-below-score posture threshold; it does not read your editor's settings.

Run your first review

Install the extension and review a project without signing in.