You'll need roughly 2 minutes to read this article.
Note that if you are using Codeship Basic, you will not be able to use the local CLI.
To list available commands, run
jet with no parameters,
jet -h or
$ jet Usage: jet [command] Available Commands: decrypt encrypt generate load run steps version Flags: -h, --help help for jet Use "jet [command] --help" for more information about a command.
Because the Jet CLI accurately reproduces your CI/CD build pipeline locally, you can use it to quickly solve difficult problems.
For instance, if a test or command fails on a build in Codeship, you can try to reproduce the error with
jet steps. When you want to test a change,
jet steps will let you verify the change is working prior to committing so that you don’t have to wait for the full build to run remotely to get feedback.
We recommend that developers using Codeship make use of the Jet CLI to improve productivity and solve build-related issues.
By default, Docker will use existing images when running
jet locally. This may lead to builds passing locally, and failing remotely on Codeship due to the remote environment starting without any prior images and therefore building an image that may be newer or different than your existing local image.
We recommend removing any locally saved Docker images prior to running
jet steps for a more consistent result to the remote server if you are seeing this issue.
To list the help for any command, execute the command followed by the
$ jet steps -h Run steps Usage: jet steps [flags] Flags: --ci-branch string The name of the branch being built --ci-build-id string The id of the build being run ...
Some flags like -e=[ ] may be used multiple times in a single command line, for example:
$ jet steps -e foo=bar -e baz=qux
Some flags require a string like
--ci-branch and can only be specified once.
$ jet steps --ci-branch master
We also have a couple of code examples and sample projects available.