Cirrus CLI is a tool for running containerized tasks reproducibly in any environment. Run your tasks locally the same way they are executed in CI or on your colleague's machine. Immutability of Docker containers ensures your project will compile years from now regardless what versions of packages you'll have locally.

• Homebrew
• Prebuilt Binary
• Golang
• CI integrations
  • Github Actions
  • Travis CI
  • Circle CI
  • Cirrus CI

Cirrus CLI reuses the same YAML configuration format as Cirrus CI which allows to reuse a large list of examples created by Cirrus CI community.

Note: Cirrus CLI can be used in any environment that has Docker installed. It can be your laptop or any CI system you already have like Jenkins, Github Actions, Travis CI, etc. With Cirrus CLI it's no longer a requirement to use Cirrus CI in order to benefit from Cirrus configuration format that we (Cirrus Labs) have crafted for so long and really proud of.

Here is an example of .cirrus.yml configuration file for testing a Go application with several Go versions:

task:
  env:
    matrix:
      VERSION: 1.15
      VERSION: 1.14
  name: Tests (Go $VERSION)
  container:
    image: golang:$VERSION
  modules_cache:
    fingerprint_script: cat go.sum
    folder: $GOPATH/pkg/mod
  get_script: go get ./...
  build_script: go build ./...
  test_script: go test ./...

To run Cirrus tasks, simply switch to a directory where the .cirrus.yml is located and run:

cirrus run

It is also possible to run a task by name:

cirrus run "Tests (Go 1.15)"

Note: Cirrus CLI only support Linux containers instances at the moment including Dockerfile as a CI environment feature.

To validate a Cirrus configuration, simply switch to a directory where the .cirrus.yml is located and run:

cirrus validate