psl check¶
Run the linter against your project:
# Check with auto-discovered config (searches upward from cwd)
psl check
# Specify config file (project root = config file's parent directory)
psl check --config path/to/config.yaml
Options¶
| Option | Description |
|---|---|
--config |
Path to a config file. The config file's parent directory is used as the project root. |
Config Auto-Discovery¶
If --config is not provided, psl check searches upward from the current working directory for either:
.python-structure-linter.yamlpyproject.toml(with a[tool.python-structure-linter]section)
The first matching file found is used, and its parent directory becomes the project root.
Exit Codes¶
| Code | Meaning |
|---|---|
0 |
No violations found |
1 |
One or more violations found |
2 |
Config error — the config file is missing or invalid (unknown rule type, unknown or missing option, invalid enum value) |