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

squirrel.toml
toml
[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
# rendering                   # omit = auto (render when logged in); set "http" or "browser" to force
render_concurrency = 6        # concurrent browser-render jobs (1-8)

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. When the estimate exceeds the cap, cloud work 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.

rendering

Default: unset (auto)

Crawl fetch mode. Leave it unset and squirrelscan decides: logged-in users render every page in a cloud browser; logged-out runs use plain HTTP. The first time an auto-render would spend credits, the CLI asks once and remembers your answer (squirrel self settings). Set it explicitly to override the auto behavior:

  • "http" - always plain HTTP; never render, never prompt (no credits)
  • "browser" - always render every page at 2 credits per page

The --render and --http flags on squirrel audit force rendering on or off for a single run and always win over config. See the browser rendering guide.

render_concurrency

Default: 6 (max 8)

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 runs 1 render at a time, Pro runs 5. 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.

Type to search…

↑↓ navigate open esc close