Settings¶
This document describes the configuration options for aitells.
Configuration can live in aitells.toml at the project root, or in pyproject.toml under the [tool.aitells] table.
Top-level¶
select¶
A list of rule codes or prefixes to enable.
Type: list[str]
Default: ["VF", "RM", "FT", "ST"] (all rules except semantic)
Example:
ignore¶
A list of rule codes or prefixes to disable.
Type: list[str]
Default: []
Example:
extend-select¶
A list of rule codes or prefixes to enable, in addition to those specified by select.
Type: list[str]
Default: []
Example:
extend-ignore¶
A list of rule codes or prefixes to disable, in addition to those specified by ignore.
Type: list[str]
Default: []
Example:
Paths¶
include¶
A list of file patterns to include.
Type: list[str]
Default: ["*.md", "*.txt", "*.rst"]
Example:
exclude¶
A list of file patterns to exclude.
Type: list[str]
Default: []
Example:
extend-exclude¶
A list of file patterns to exclude, in addition to those specified by exclude.
Type: list[str]
Default: []
Example:
Output¶
format¶
Output format for findings.
Type: "text" | "json" | "sarif" | "markdown" | "github"
Default: "text"
Example:
quiet¶
Suppress non-error output.
Type: bool
Default: false
Example:
Rules¶
Rule-specific configuration. Each rule can be configured under its kebab-case name.
rules.<rule>.enabled¶
Enable or disable a specific rule.
Type: bool
Default: Depends on rule category (see select default)
Example:
rules.<rule>.threshold¶
For density-based rules, the threshold at which to trigger.
Type: int
Default: Rule-dependent
Example:
rules.<rule>.ignore-patterns¶
Patterns to ignore for a specific rule.
Type: list[str]
Default: []
Example:
LLM¶
Configuration for semantic analysis rules (SE*).
llm.enabled¶
Enable LLM-based semantic analysis.
Type: bool
Default: false
Example:
llm.model¶
Model to use for semantic analysis.
Type: str
Default: "claude-3-haiku-20240307"
Example:
llm.api-key-env¶
Environment variable containing the API key. When running inside Claude Code, authentication is automatic.
Type: str
Default: "ANTHROPIC_API_KEY"
Example: