CLI Reference
Quick CLI, path, option, and safety reference.
Quick CLI, path, option, and safety reference.
Diagnose configuration, target, environment, and workflow failures.
Configuration: path-header-scanner init
Configuration: path-header-scanner scan
Reference every supported Path Header Scanner configuration section and its command scope.
Prepare a focused, tested, documented, and safe Path Header Scanner contribution.
Understand path headers, language strategies, preview mode, apply mode, and dry-run guarantees.
Install Path Header Scanner in editable mode and configure its pre-commit quality workflow.
Pull Path Header Scanner production images with immutable or moving stable tags.
Examples: path-header-scanner init
Examples: path-header-scanner scan
Understand responsibilities and execution flow.
FAQ: path-header-scanner init
FAQ: path-header-scanner scan
Install the CLI, initialize project configuration, and run a safe first workflow.
Choose the initialization mode, replacement policy, and dry-run behavior.
Options: path-header-scanner scan
Interpret initialization plans, resource counts, and completion status.
Output: path-header-scanner scan
Understand responsibilities and execution flow.
Create project-owned scanner configuration and supporting resources.
Discover supported files, validate path headers, preview missing or stale headers, and apply corrections only when explicitly requested.
Understand the project configuration file, precedence, and active sections.
Understand Path Header Scanner's contributor workflow, scan boundaries, and quality tools.
Install the CLI, initialize project configuration, and run a safe first workflow.
Quick CLI, path, option, and safety reference.
Diagnose configuration, target, environment, and workflow failures.
Choose a workflow by its target and side effects.
Choose a workflow by its target and side effects.
A writable project directory. Python 3.11+ package compatibility; Python 3.14 is the standard runtime. Review existing .config/path_header_scanner resources before --force.
A readable target directory. Write permission only when --apply is used. Supported Python, JavaScript, shell, HTML, PHP, or Markdown files.
Syntax: path-header-scanner init
Syntax: path-header-scanner scan
Test Path Header Scanner preview, apply, language strategies, initialization, and dry-run behavior.
Troubleshooting: path-header-scanner init
Troubleshooting: path-header-scanner scan
Workflow: path-header-scanner init
Workflow: path-header-scanner scan