Skip to content

Concepts

Term Meaning
Configuration The checks, tool files, and rules for one language, framework, library, platform, or topic, such as python. The configuration reference lists them.
Check A tool check runs a tool, such as ESLint. A built-in check runs code in gspot. A command check runs your own command.
Check ID <configuration>/<name>, such as python/ruff. --only, gspot ignore, and gspot explain take it. A command check takes its name as its ID.
Finding One result of a check: a message, often with a file, line, column, lint rule, and help.
Lint rule One instruction for a linter, such as no-console.
Rules Markdown for coding agents, under .gspot/configurations/<group>/<configuration>/rules/ and listed in AGENTS.md. See Coding agents.
Settings The values in gspot.toml. See gspot.toml.
Level recommended or all. See Levels.
Stage When a check runs. commit checks run in the pre-commit hook. push checks run with the commit checks in the pre-push hook, in CI, and in gspot check. message checks run in the commit-msg hook. manual checks run only when --only names them, and in the CI job on the default branch.
Scope A folder with its own configurations and settings. See Monorepos.
Generated file A file that gspot writes from your settings. See Generated files.
LevelWhat it checksShipped checksTools it adds
recommended (default)Bugs, security and accessibility problems, type errors, formatting, and misuse of declared frameworks and libraries. Choose it for an existing codebase or a first run.104—
allAlso naming, wording, code structure, doc comments, declaration order, duplication, API style, and complexity. Choose it for a new repository or one that coding agents write.127commitlint, jscpd, syncpack

The counts cover every shipped configuration. Your repository runs only its selected and applicable checks.

To change the level and install any extra tools:

gspot set level all
gspot install

Run gspot set level recommended to return to the default level.