Docs

Your agent runs its tests with shipcheck run, and that run gives the GitHub check its PR waits for. shipcheck starts the run itself: it runs your checks locally, natively in an OS sandbox or as your workflows in containers with act, keeps the result for each git tree, and posts one required check per job, such as shipcheck/test.

New here? Install it, then follow the quickstart. It takes a few minutes for a repository owner and one command for each teammate. Once it works, speed up runs.

Using a coding agent? Agents says what init writes for it, with any agent.

Deciding whether to trust it? What a green check proves and Security say what a check guarantees and what a job can reach.

• Install

  What shipcheck needs on the machine, and how to install it.

• Quickstart

  Set up a repository once, then each clone once, then work as usual.

• Require the check

  Make main accept a PR only after its shipcheck check passes.

• Agents

  How a coding agent learns to run shipcheck instead of the tests and git commit, with any agent.

• shipcheck.toml

  Every setting of the one file the repository owner writes.

• Speed

  How long shipcheck took against GitHub's hosted runners on the same commits, the slower runs included.

• Speed up runs

  Use host mode, shard pytest, let jobs download, keep caches, and pick a Docker engine.

• Commands

  The commands, their exit codes and their environment variables.

• How it works

  What shipcheck runs, where, and when it trusts a stored result.

• What a green check proves

  What a passing shipcheck job check guarantees, and what it does not.

• Security

  What a job can reach on your machine, what the App can do on GitHub, what the service stores, and how to report a vulnerability.

• Limits

  What shipcheck does not catch, and what act cannot run.