squirrelscan
GitHub

Cloud Settings

Configure cloud features, spend limits, and browser rendering

The [cloud] section of squirrel.toml controls cloud features: whether they run, how much an audit may spend, and whether pages are rendered with a cloud browser.

All cloud settings are no-ops when you’re not logged in - cloud rules simply report skipped.

Options

[cloud]
enabled = true                # master switch for all cloud features
max_credits_per_audit = 1000  # hard spend cap per audit; 0 = unlimited
confirm_threshold = 50        # estimates above this prompt for confirmation
batch_size = 20               # pages per cloud service request
editor_summary = true         # auto-generate an editor's summary (included in the audit base)
# rendering                   # omit = auto (render when logged in); set "http" or "browser" to force
render_concurrency = 6        # concurrent browser-render jobs (1-10)
publish = true                # auto-publish to your dashboard when logged in
visibility = "unlisted"       # default visibility for published reports

enabled

Default: true

Master switch. Set to false to disable all cloud calls for this project - cloud rules report skipped, publishing and rendering are unaffected by other settings.

max_credits_per_audit

Default: 1000

Hard cap on credits a single audit may spend. Every audited page costs 2 credits on top of the 50-credit base, so a page limit the cap can’t cover is lowered to fit it, with a notice: the default of 1000 covers 475 pages. Cloud enrichment past the cap is truncated deterministically and the rules that didn’t run report skipped with reason credit-cap-reached. Set to 0 for unlimited.

confirm_threshold

Default: 50

In an interactive terminal, an estimated spend above this value prompts for confirmation before the cloud phase runs. Set to 0 to always confirm. Non-interactive runs (CI, agents, pipes) never prompt - they proceed bounded by max_credits_per_audit. Pass --yes to skip the prompt explicitly.

batch_size

Default: 20 (also the maximum)

Pages per request to per-page cloud services. Lower it only if you hit request-size limits with very heavy pages.

editor_summary

Default: true

Auto-generate an editor’s summary at the top of the report: an exec-email-style narrative, a one-line verdict and ranked priorities for the site’s stack. Runs on any signed-in plan, free or Pro; included in the audit base charge. Set to false to disable it for this project.

render

Default: unset (auto)

Render strategy: the canonical control (supersedes rendering). Leave it unset and the audit level decides: surface and full render every page, and quick crawls HTTP-first and renders only the pages that need it (logged-in only). Set it explicitly to pin behavior, which makes the audit custom when it differs from the level’s:

  • "off" - plain HTTP only; never render in the cloud
  • "auto" - HTTP-first: render only pages detected as client-side-rendered shells; static / server-rendered pages use fast plain HTTP
  • "all" - render every HTML page

The mode does not change the price: a signed-in audit costs 2 credits per audited page however the page is fetched, plus the 50-credit base. See Credits and pricing.

robots.txt, XML sitemaps, and non-HTML assets are never rendered at any level; "all" means every crawled HTML page.

[cloud]
render = "auto"   # only render the pages that actually need a browser

The --render-mode off|auto|all flag on squirrel audit overrides this for a single run (--render / --http are shorthands for all / off). See the browser rendering guide.

rendering (deprecated)

Default: unset (auto)

Legacy fetch-mode toggle, kept for back-compat. Maps onto render: "http" → off, "browser" → all. Prefer render; if both are set, render wins.

render_concurrency

Default: 6 (max 10)

How many cloud browser-render jobs run at once during a rendered crawl. Render jobs run in squirrelscan’s cloud, so the usual per-host politeness delay doesn’t apply to job submission - but the render workers do fetch your site, hence the cap. Raise it to speed up large rendered audits; lower it if your origin is sensitive to parallel traffic.

Your plan also caps this value: Free renders 1 page at once, Pro 5, Team 10, per audit. Cloud audits are held to the same numbers. The CLI checks your plan at the start of each rendered crawl and uses the lower of the two - a config value above your plan limit isn’t an error, it just gets clamped.

publish

Default: true

Auto-publish the audit report to your dashboard when you’re logged in and online - independent of cloud rendering or enrichment. Publishing is included in the audit base charge, whatever the visibility. Logged-out and --offline runs never publish. Set to false to never auto-publish for this project; you can still publish a single run with --publish (it overrides this). Skip publishing one run with --no-publish.

visibility

Default: "unlisted"

Default visibility for published reports: "public" (listed and searchable), "unlisted" (accessible via direct link only), or "private" (only you, when logged in). Override per-run with --visibility. Publishing is included in the audit base charge, whatever the visibility.

Type to search…

↑↓ navigate↵ openesc close