Configuration Reference

🚀Configuration Reference

v1.0.1 Reference

Map supported configuration keys to the commands that consume them.

Command.config/path_header_scanner/config.toml

📦Category

Configuration

🚀Quick Command

CLI option > project configuration > internal default

Supported sections

TOML section	Supported keys	Used by
[tool.path-header-scanner.cli.execution]	dry_run, debug	Shared execution defaults; dry_run affects init and scan
[tool.path-header-scanner.initialization]	force, ask	path-header-scanner init
[tool.path-header-scanner.cli.scan]	target_directory, apply, include_target_directory	path-header-scanner scan
[tool.path-header-scanner.logging]	level, Rich display flags, console_format	Console diagnostics
[tool.path-header-scanner.logging.file]	file level/path, rotation, and file_format	Persistent diagnostics

Safe scan defaults

toml

[tool.path-header-scanner.cli.execution]
dry_run = false

[tool.path-header-scanner.cli.scan]
target_directory = "app"
apply = false
include_target_directory = true

⚠️Dry-run wins over apply

An explicit or configured dry-run disables effective apply mode. The scan may still discover and validate files, but it does not modify them.

ℹ️CLI-only working directory

--workdir changes the base used to resolve a relative scan target. It is a CLI option, not a supported persistent configuration key in v1.0.1.

Unknown keys do not become command options. Compare configuration names with the scan options and init options before relying on them in automation.