Open source · local · offline
Know you're ready
before you ship.
A minimal CLI that checks your project for common release blockers.
go install github.com/App-Chef/shipcheck/cli/cmd/shipcheck@latestexit code 0
$ shipcheck SHIPCHECK ✓ Git repository✓ Working tree clean✓ On branch main✓ Tests passed✓ Production build passed✓ Environment checked✓ README found✓ License found (MIT)✓ Version 1.4.0⚠ No CI configuration → Add a CI workflow so every push is tested (shipcheck runs in CI too). ──────────────────────────── 9 passed · 1 warning ✓ Ready to shipThe problem
You finished the feature.Tests pass.You deploy.Then something breaks because you forgot one small thing.
It's rarely the hard part that breaks a release. It's
- a file you never committed
- an API key missing in production
- a build that only breaks in production mode
- a version number you already released
Solo developers and small teams don't have a release manager to catch these.
The solution
Run shipcheck before you ship.
01
Run
shipcheck02
Check
Shipcheck inspects your project: Git, tests, build, environment and more.
03
Ship
Fix what matters and deploy with confidence.
Checks
Everything that is easy to forget.
Test and build commands are detected for Go, Node.js, Python, Java, PHP and Rust. No setup required.
Git
Repository present, working tree clean, on the branch you ship from.
✓ Working tree clean
Tests
Detects your test runner and runs it. Fails if any test fails.
✓ Tests passed
Build
Runs your production build so compile errors surface before deploy.
✓ Production build passed
Environment
Required variables are set, and values are never printed.
✓ Environment checked
README
The project explains what it is and how to run it.
✓ README found
License
A license file exists, and common licenses are recognised.
✓ License found (MIT)
Version
Finds your version, and warns if that version was already released.
✓ Version 1.4.0
CI
Continuous integration is configured. Recommended, not required.
✓ CI configured (GitHub Actions)
CI
The same checks, on every push.
Shipcheck exits 0 when you're ready and 1 when you're not, so any CI system can run it. --json prints a clean report for scripts and build artifacts.
- Stable exit codes: 0 ready, 1 not ready, 2 error
- JSON only on stdout, never mixed with text
- Secrets are checked for presence, never printed
- name: Install Shipcheck run: go install github.com/App-Chef/shipcheck/cli/cmd/shipcheck@latest- name: Run Shipcheck run: shipcheck --json > shipcheck.json$ shipcheck --json | jq '.ready'false$ shipcheck && ./deploy.shOpen source
Yours to read, run and change.
Shipcheck is MIT licensed and runs entirely on your machine. There's nothing to sign up for.
- No account
- No sign-up, no API key, no login.
- Offline
- No network access. Works on a plane.
- No telemetry
- Nothing about you or your code is collected.
- Read-only
- Never edits, deletes or commits your files.
Ready to ship?
Install Shipcheck and run one command.