FailPackDocs

FailPack CLI documentation

Capture failed commands, logs, git state, project metadata and sanitized context into reports that are ready for AI assistants, GitHub issues, teammates and support.

Current package
@failpack/cli
01

Installation

Install the CLI globally and run it from inside the project you want to debug.

npm install -g @failpack/cli
failpack

On first run in a repository, FailPack asks whether you trust the current folder and creates a local .failpackrc.json when accepted.

02

Your first capture

Run a failing command through FailPack to create a local report package.

failpack capture --cmd "npm run build"
failpack capture --cmd "npm test" --project ./my-app --no-zip
03

Interactive app

Running failpack opens a terminal app with project status, recent report state, account/cloud state, activity log and command suggestions.

run <command>reportstatusfix [version]unfix [version]cleandoctoranalyzesecurityloginlogoutwhoamicloud uploadcloud synccloud open <id>cloud delete <id>
04

One-shot commands

Use direct commands in scripts, CI reproductions or when you already know the action.

failpack ai --error ./error.log --include-diff
failpack report --github --discord
failpack status
failpack fix v1
failpack unfix v2
failpack doctor
failpack init
failpack clean --yes
05

Capture options

Tune what gets captured, how much output is preserved and where reports are written.

--cmd "npm run build"Command to run and capture
--project ./my-appProject directory
--no-zipSkip ZIP bundle creation
--no-gitSkip git context
--include-sourceInclude a limited source snapshot
--max-log-lines 800Keep the last N output lines
--timeout 600Command timeout in seconds
--output .failpack/reportsOutput directory
--no-redactDisable redaction for local output
06

Output files

By default, FailPack writes local files to .failpack/reports.

failpack-report.md

Readable local report for teammates, support or GitHub.

failpack-ai-prompt.md

Prompt-shaped failure context for AI assistants.

failpack-context.json

Structured metadata, logs, git state and environment signal.

failpack-bundle.zip

Optional portable bundle for private sharing.

07

Report status

Each report version has its own status, so fix tracking remains explicit.

failpack status
failpack fix v1
failpack unfix v2
failpack fix v1 --yes
08

Cloud and AI

Local commands work without login. Cloud and AI commands require FailPack Cloud and a logged-in account.

Production APIPublished builds use https://api.failpack.dev/v1.
AI analysisUse failpack analyze or failpack security after login.
failpack login
failpack whoami
failpack cloud upload
failpack cloud sync
failpack analyze
failpack security
09

Security model

FailPack is designed to collect debugging context without turning reports into secret dumps.

Common keys, tokens and credentials are redacted before reports are saved.
.env files and private keys are ignored by default.
Nothing is uploaded unless you explicitly run or confirm a cloud command.
Ready to package a failure?

Install the CLI, run one capture, then review the generated Markdown before sharing.

Back to product