This article is about Codeship Pro.

Installing the Jet CLI

You will need roughly 2 minutes to read this article.

Prerequisites

In order to run the jet binary on your computer, you need to have Docker installed and configured, with a running Docker host such as Docker For Mac.

Installing Jet

Please follow the steps below for the operating system you are using. See the Jet Release Notes for the ChangeLog.

See the sha256sums file for checksums for the latest release. To check the downloaded files on Linux / Unix based systems run the following command.

shasum -c -a 256 sha256sums

Installing Jet On Mac OS X

The jet CLI is now included in our custom Homebrew Cask. If you already have Homebrew installed you can install jet by running the following command

brew cask install codeship/taps/jet

If you don’t have Homebrew installed or don’t use Homebrew Cask you can install jet via the following commands.

curl -SLO "https://s3.amazonaws.com/codeship-jet-releases/2.9.0/jet-darwin_amd64_2.9.0.tar.gz"
tar -xC /usr/local/bin/ -f jet-darwin_amd64_2.9.0.tar.gz
chmod u+x /usr/local/bin/jet

Installing Jet On Linux

curl -SLO "https://s3.amazonaws.com/codeship-jet-releases/2.9.0/jet-linux_amd64_2.9.0.tar.gz"
sudo tar -xaC /usr/local/bin -f jet-linux_amd64_2.9.0.tar.gz
sudo chmod +x /usr/local/bin/jet

Installing Jet On Windows

There is no supported Jet version for Windows machines, although Windows Subsystem For Linux works for many of our customers.

Dynamically linked version

The above version is statically linked and will work the same way on all platforms. But it doesn’t support certain features, e.g. resolving .local DNS names. If your builds require this, please use the dynamically linked version instead.

Validating Installation

Once this is done you can check that Jet is working by running jet help. This will print output similar to the following.

$ jet version
2.9.0
$ jet help
Usage:
  jet [command]
...

Updating

Once jet is installed, you can use the jet update command to quickly update to the newest version. You can read the jet update documentation for more information.

Docker Configuration

DOCKER_HOST must be set. DOCKER_TLS_VERIFY and DOCKER_CERT_PATH are respected in the same way as with the official Docker client. If you installed Docker via Docker For Mac this is typically done by default during installation.

If you installed and configured your Docker environment via Docker Machine (and you are on OS X or Linux) and named the environment dev, running the following command will set those variables.

eval $(docker-machine env dev)

Need more help?

Contact our support team or post on Stack Overflow using the tag #codeship. Did you check the status page and changelog?

There are also several code examples and sample projects available for you to get started with.

Article not helpful?

Does this article need improvement? If so, please send feedback or submit a pull request!