FAQ

Common questions and fixes.

General

Is shipctl free?

Yes. shipctl is open source under the MIT license.

Which platforms are supported?

macOS, Linux, and Windows via WSL2. See Requirements.

Deploys

How do I deploy from CI?

Set SHIPCTL_TOKEN as a CI secret and run:

shipctl deploy --env production --yes

Why did my deploy exit with code 3?

The release failed its health check. Inspect it with shipctl logs --env <name> and check healthcheck.path in your config.

Can I deploy to multiple environments at once?

Not in one command. Run shipctl deploy once per environment, or loop over them in your CI script.

Troubleshooting

command not found: shipctl

The install directory is not on your PATH. Add it:

export PATH="$HOME/.local/bin:$PATH"

Config file not detected

Run shipctl --verbose status to print which config paths were checked.

How do I turn off colors?

Set NO_COLOR=1 in your environment.

Getting help

Run shipctl help, or open an issue on the project's issue tracker with the output of shipctl --version.