GitHub

Audit Settings

Choose which rules run for your organization's cloud audits and toggle external link checking

Cloud audits don’t read your local squirrel.toml, so the Settings → Audit page in the dashboard is where you control which rules run in the cloud for everyone in your organization.

Open it at Dashboard → your org → Settings → Audit. Owners and admins can edit; other members see a read-only view.

Rule selection

Every audit rule is on by default. The page lists all rules grouped by category (sorted by priority). For each rule you can:

  • Toggle it on or off individually.
  • Toggle a whole category with the category master switch (it shows a mixed state when only some rules in the category are on).
  • Enable all / Disable all across every category.
  • Search by rule name or id to jump to a specific rule.

The header shows how many rules are enabled out of the total. Changes are staged locally — click Save to apply them.

This setting is per organization: it applies to all cloud audits the org runs (dashboard-triggered and scheduled). It does not affect CLI audits, which keep using your local config.

Credit-backed rules

Some rules are powered by cloud services and spend credits when they run. These are marked with a credit badge showing the per-unit cost (for example 1 cr/page). Turning them off is also a way to cap what an audit can spend. See Credits for the full pricing.

A separate card toggles external link checking for cloud audits. When on, audits verify that outbound links resolve, using the dead-links service. It’s off by default because it’s credit-gated (1 credit per 100 URLs). The card links to your org’s credit usage.

Max credits per audit

The Max credits per audit card sets a hard spend ceiling for a single cloud audit of this website. Leave it blank for no cap.

  • Manual runs whose estimate exceeds the cap are blocked — the Run dialog shows an error and the audit doesn’t start. Raise the cap (or lower the crawl depth) to proceed.
  • Scheduled runs that would exceed the cap are skipped, and you get an in-app notification (“Scheduled audit skipped…”) so a recurring audit can never bill-shock.
  • When a run proceeds, the cap is also passed to the cloud worker as a runtime ceiling, so spend stops there even if the actual cost climbs.

The estimate is an upper bound — actual cost is billed per feature as the audit runs (see Credits), so most audits cost less than the cap. This setting is per website.

What runs where

SurfaceHonors org audit settings?
Dashboard cloud auditsYes
Scheduled cloud auditsYes
CLI audits (squirrel audit)No — uses your local squirrel.toml

Per-rule option tuning (thresholds and the like) and per-website overrides aren’t configurable here yet — they’re tracked as follow-ups.

Type to search…

↑↓ navigate open esc close