config

The config command lets you inspect and modify your squirrel.toml configuration file without editing it manually.

Subcommands

show

Display the current configuration with the resolved file path:

squirrel config show

Output:

Config file: /path/to/squirrel.toml

[project]
domains = []

[crawler]
max_pages = 500
...

set

Update a configuration value using dot notation:

squirrel config set crawler.max_pages 100

squirrel config set rules.disable '["ai/*"]'

Options

Preview what would change:

squirrel config set crawler.max_pages 100 --dry-run

Output:

Would set crawler.max_pages = 100

[project]
domains = []

[crawler]
max_pages = 100
...

path

Print the path to the active config file:

squirrel config path

Output:

/Users/you/project/squirrel.toml

Useful for scripting or verifying which config file is in use.

validate

Check that your config file is valid TOML and passes schema validation, and that every [rule_options] table names a rule, sets only options that rule declares, and gives each one a value of the right type:

squirrel config validate

Output on success:

Config valid: /path/to/squirrel.toml

Output on error:

Invalid config: crawler.max_pages: Expected number, received string

Each rule option problem gets its own line, naming the table and the option:

Invalid config: [rule_options."performance/ttfb"]: no rule has this id, so the table changes nothing (did you mean "perf/ttfb"?)
Invalid config: [rule_options."core/meta-title"] min_length: Invalid input: expected number, received string

The command exits 1 on any problem. See what happens to a mistake for how squirrel audit treats the same problems.

Examples

Check current settings

squirrel config show

Increase crawl limit

squirrel config set crawler.max_pages 200

Preview a change

squirrel config set crawler.concurrency 10 --dry-run

Disable AI rules

squirrel config set rules.disable '["ai/*"]'

Verify config before deploy

squirrel config validate && echo "Config OK"

Config file resolution

squirrelscan searches for squirrel.toml starting from the current directory and walking up to your home directory. The first config file found is used.

squirrel --config-file <path> config <subcommand> uses that file instead, as squirrel --config-file <path> audit does, so config validate checks the config an audit will use.

If no config file exists, commands that require one will prompt you to run squirrel init.

See also

• Configuration Reference - Full config file documentation
• init - Create a new config file