Faultline Docs

Quickstart

  1. Install the scanner.
    go install github.com/faultline-go/faultline/cmd/faultline@latest
    faultline version
  2. Run an HTML report locally.
    faultline scan ./... --format html --out faultline-report.html
  3. Create a metadata-only snapshot for Enterprise.
    faultline scan ./... --format snapshot --out faultline-snapshot.json
  4. Upload directly during CI or local evaluation.
    faultline scan ./...   --enterprise-url https://api.gofaultline.dev   --enterprise-token "$FAULTLINE_API_TOKEN"   --enterprise-org-id "$FAULTLINE_ORG_ID"
  5. Keep source local. The default scanner workflow does not upload source code, run a server, or require runtime network access.
Faultline is strongest for Go-heavy repositories today. Non-Go repos can still participate in Enterprise workflows when metadata and policy signals are available.