credits

Show cloud credit balance and audit pricing

The credits command shows your cloud credit balance, plan, and current audit pricing.

Usage

squirrel credits [options]

Requires login - run squirrel auth login first.

Options

Option	Description
`--json`	Output as JSON
`--upgrade`	Print the upgrade URL and open it in your browser

--upgrade does not require login, so you can go straight to the upgrade page from any machine. Because it answers before reading your balance, it prints the general upgrade URL: the organization-scoped link in the output below only appears once the CLI has read an organization’s balance.

squirrel credits --upgrade

Example

squirrel credits

Plan:    Pro
Balance: 2340 credits (2000 monthly + 340 purchased)
         monthly credits reset 2026-07-08

Pricing:
  audit                 50 base + 2 per audited page
                           (analysis, tech detection, publishing included)
  external links         1 per link the cloud verifies for an audit, at most 1 per page
                           (internal links, and links checked from your machine, are free)
  content_gaps          25 per run
  keyword_gaps          25 per run

Top up: https://app.squirrelscan.com/upgrade?plan=pro&interval=month&org=01J0ORGEXAMPLE0000000000A&src=cli

On the free plan the output ends with the Pro offer instead:

  Pro: $19/month (or $190/year) for 3,000 credits a month
  Also unlocks daily audits on every site, faster crawls, and up to 2,000 pages per audit.
  Upgrade: https://app.squirrelscan.com/upgrade?plan=pro&interval=month&org=01J0ORGEXAMPLE0000000000A&src=cli
  Compare plans: https://squirrelscan.com/pricing?src=cli-credits
  Or run `squirrel credits --upgrade`.

A balance below 52 credits cannot start any signed-in audit, since the smallest one is the flat 50 credit base plus 2 for its first page. squirrel credits calls that out rather than showing a positive number you cannot spend. Above that, a balance too small for a full audit shrinks the audit’s page limit instead of refusing it. See Credits and pricing.

JSON output:

squirrel credits --json

{
  "balance": { "total": 2340, "monthly": 2000, "pack": 340, "periodEnd": "2026-07-08T00:00:00Z" },
  "plan": { "id": "starter", "name": "Pro" },
  "pricing": { "render": { "cost": 2, "per": 1, "unit": "page" } }
}

Credits & Pricing - how credits work and what an audit costs
auth - log in to enable cloud features

Edit this page

Usage

Options

Example

Related