Skip to main content

Installation and First Workflow

Installation and First Workflow

Recommended

Use a dedicated environment, preview setup, and review a scan before applying header changes.

CommandPath Header Scanner

Category

Getting Started

Quick Command

path-header-scanner scan app

Install a Reviewed Release

Authorized users can install from the private GitLab PyPI registry with the project ID and a deploy token limited to read_package_registry.

Private GitLab package
bash
python -m venv venv

# Activate the environment, then install one reviewed package version.

python -m pip install --index-url "https://<deploy-user>:<deploy-token>@gitlab.com/api/v4/projects/<project-id>/packages/pypi/simple" "path-header-scanner==1.0.1"

path-header-scanner --version

A Git tag such as v1.0.0-rc.1 becomes PEP 440 package version 1.0.0rc1. Use path-header-scanner==1.0.0rc1 when deliberately testing that release candidate. This package is private; do not commit tokens or credential-bearing index URLs.

Install from a Source Checkout

Environment
bash
python -m venv venv
python -m pip install .
path-header-scanner --version
Safe first workflow
bash
cd /path/to/project
path-header-scanner init --dry-run
path-header-scanner init

# Scan is preview-only by default

path-header-scanner scan app

# Apply only after reviewing the preview

path-header-scanner scan app --apply