Skip to content
Docs

Start an audit

View Markdown

Start a security audit of a repository. You need the Member or Admin role.

Ask your agent

Use Zero Cool to start a full audit of the src directory of this repository at the current commit. Show me the scope and the price, and wait for my approval before you launch it.

For a diff review, name the base commit. The agent pushes nothing and spends nothing without your approval.

In the portal

The form is one page.

  1. Open your workspace and select New audit.
  2. At the top, choose Full audit, Diff review or Fix review under Audit type. Beside it, choose Agile or Deep under Audit mode. Each label has an i tooltip. A full audit defaults to Deep. Diff reviews and fix reviews default to Agile.
  3. Use the GitHub source picker to select the connection, repository, branch and commit. For a review, also select the base commit or audited commit.
  4. Under Scope, use Paste in scope or select files in the file tree. Select Confirm source at the bottom of Scope.
  5. Set Audit name (optional), or keep the default repository names.
  6. Check Price for the selected mode and scope.
  7. Open Advanced options to add Context files, set Targeted audit focus or choose Report format. A standalone fix review requires the earlier report as a context file.
  8. Select Review and start audit to open Confirm audit details. Check the source, scope, mode and price, then select Start audit.

For a full audit, a Deep audit suggests 2.5 × lines^0.8 credits, rounded up, with a 500-credit minimum. An Agile audit suggests 0.625 × lines^0.8 credits, rounded up, with a 250-credit minimum. Lines include comments and blank lines in scope. Check the quote for the price before you create the audit. Complete is available only to Zero Cool staff.

CLI

Run these in your repository checkout. Push the commit first.

zerocool config edit --new --workspace "<workspace>" --type scan --scope src --name "My audit"
zerocool quote
zerocool launch

To choose an Agile audit, run zerocool config edit --mode agile before zerocool quote. For a Deep audit, use zerocool config edit --mode deep. The quote shows the selected mode and its price. Checking a price costs nothing.

When your coding agent runs these commands, it shows you the scope and price and waits for your approval. After you approve, it runs zerocool launch --yes to confirm the launch. If you run zerocool launch yourself, confirm at the prompt after reviewing the price.

Next: Follow an audit and read findings.