Getting started

Getting started

Preflight is a command-line tool that scans your codebase for launch readiness. It finds missing configuration, broken integrations, security gaps, SEO metadata that isn’t there, and the other mistakes that are easy to ship and embarrassing to find in production.

It runs on your machine or in CI. Your code never leaves it, and you don’t need an account.

Install

Pick whichever fits your machine:

Or download a binary for your platform from GitHub Releases.

Set up a project

Run preflight init in your project’s root. It detects your stack and the services you use, asks for your staging and production URLs, and writes what it learned to preflight.yml.

cd your-project
preflight init

Commit preflight.yml. Everyone on the project, and your CI, then scans with the same settings. Configuration covers every key in it.

Run a scan

preflight scan

Each check prints one line: ✓ OK, ⚠ WARN or ✗ FAIL, followed by what it found and how to fix it. The last line says whether the project is ready to launch. A scan that finds only warnings exits 1, and one that finds an error exits 2, so a CI step fails exactly when it should. Scanning has every flag and exit code.

Where next

• Checks: what each check looks for, and its ID.
• Ignoring checks: silence a check that doesn’t apply, or allow one known secret.
• CI: run Preflight on every pull request.
• Agent skill: let your coding agent run scans and fix what they find.
• Dashboard: keep a history of runs and get AI fix suggestions.

Questions and false positives

Preflight tries hard to be right, but a check can misread an unusual project. If one does, or you have a question, write to us or open an issue on GitHub.