Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pipefort.com/llms.txt

Use this file to discover all available pages before exploring further.

The CLI is the original surface for Pipefort’s scan engine. It targets a single repo at a time — local directory or remote GitHub URL — and writes findings to your terminal or stdout in JSON. It runs entirely offline (other than fetching a remote repo via git clone), making it well-suited for CI gating and pre-commit hooks.

When to reach for the CLI

Pre-commit / IDE checks

Scan the working copy of a repo you’re editing locally.

CI gating

Run as a GitHub Actions step that fails the build on findings at or above a chosen severity.

Auditing a single repo

Point -g owner/repo at any public GitHub repo and get a posture report in seconds.

Triage + auto-fix

Run with --fix to have the scanner rewrite YAML in place for fixable categories.

When to use the web app instead

The CLI scans one repo at a time and persists nothing. For continuous, multi-repo visibility — historical trends, organization-wide posture, deep links from the dashboard back to GitHub — use the web app.

Next

Installation

Download and install the binary for your platform.

Usage

Examples for local, remote, single-file, and JSON output.