Installation

With Go

If you have Go 1.22 or newer, install the latest version with one command:

$ go install github.com/App-Chef/shipcheck/cli/cmd/shipcheck@latest

The binary is placed in $(go env GOPATH)/bin, which is usually ~/go/bin. Make sure that directory is on your PATH:

export PATH="$PATH:$(go env GOPATH)/bin"

On Windows, Go adds %USERPROFILE%\go\bin to your PATH during installation.

From source

Clone the repository and build the binary yourself:

$ git clone https://github.com/App-Chef/shipcheck.git$ cd shipcheck/cli$ go build -o shipcheck ./cmd/shipcheck$ ./shipcheck version

Move the resulting shipcheck binary anywhere on your PATH.

Verify the installation

$ shipcheck --version

This prints the installed version. Builds installed with go install report the module version, and shipcheck version --verbose also shows the commit, build date and Go version.

Requirements

• Git for the Git checks. Without it, the working tree and branch checks are skipped and everything else still runs.
• Your project's toolchain (for example node, cargo or mvn) for the tests and build checks. Shipcheck runs your commands; it doesn't bundle them.

Uninstall

Shipcheck stores no data outside your project. Delete the binary to remove it:

$ rm "$(go env GOPATH)/bin/shipcheck"

Next: run your first check.