Skip to main content

38 docs tagged with "path-header-scanner"

View all tags

Common Problems

Diagnose configuration, target, environment, and workflow failures.

Contributing

Prepare a focused, tested, documented, and safe Path Header Scanner contribution.

Core Concepts

Understand path headers, language strategies, preview mode, apply mode, and dry-run guarantees.

Development Setup

Install Path Header Scanner in editable mode and configure its pre-commit quality workflow.

Docker

Pull Path Header Scanner production images with immutable or moving stable tags.

Examples

Examples: path-header-scanner init

Examples

Examples: path-header-scanner scan

FAQ

FAQ: path-header-scanner init

FAQ

FAQ: path-header-scanner scan

Options

Choose the initialization mode, replacement policy, and dry-run behavior.

Options

Options: path-header-scanner scan

Output

Interpret initialization plans, resource counts, and completion status.

Output

Output: path-header-scanner scan

Overview

Understand responsibilities and execution flow.

Overview

Create project-owned scanner configuration and supporting resources.

Overview

Discover supported files, validate path headers, preview missing or stale headers, and apply corrections only when explicitly requested.

Overview

Understand the project configuration file, precedence, and active sections.

Overview

Understand Path Header Scanner's contributor workflow, scan boundaries, and quality tools.

Overview

Install the CLI, initialize project configuration, and run a safe first workflow.

Overview

Quick CLI, path, option, and safety reference.

Overview

Diagnose configuration, target, environment, and workflow failures.

Overview

Choose a workflow by its target and side effects.

Requirements

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.

Requirements

A readable target directory. Write permission only when --apply is used. Supported Python, JavaScript, shell, HTML, PHP, or Markdown files.

Syntax

Syntax: path-header-scanner init

Syntax

Syntax: path-header-scanner scan

Testing

Test Path Header Scanner preview, apply, language strategies, initialization, and dry-run behavior.

Workflow

Workflow: path-header-scanner init

Workflow

Workflow: path-header-scanner scan