Skip to main content

Overview

Initialize Path Header Scanner

Writes Configuration

Create the project-owned configuration used by Path Header Scanner.

Commandpath-header-scanner init

Category

Initialization

Quick Command

path-header-scanner init [OPTIONS]
project setupconfigurationdry-run
Default Mode
all
Supported Modes
all and config
Target
.config/path_header_scanner/config.toml
Dry-run
No filesystem writes

Overview​

path-header-scanner init prepares an existing project by creating its configuration directory and configuration file. The current v1.0.1 CLI exposes two modes, all and config; both currently plan the same configuration resource.

What the command does

  1. Resolve the mode and initialization settings.
  2. Build a plan for .config/path_header_scanner/config.toml.
  3. Display the plan and stop when dry-run is active.
  4. In live mode, create or skip the resource according to --ask and --force.
  5. Render created, copied, skipped, and directory counts.