Get Started

cirocket is a cross platform task runner supporting automation of development and ci build tasks.

Quick start

• installation instructions for a variety of platforms
• Explore cirocket concepts.
• Configuration reference.
• Hello World mission example

Key Features

• Task runner using simple YAML configuration
• Task sets are called missions that are hierarchically broken down into stages and tasks.
• Supports templated parameters using Go templates.
• Config include files supported.
• Multi-platform
  • Linux
  • Macos
  • Windows
  • Docker

Hello world mission

name: "sample mission"
params:
  - name: welcome
    value: hello world

stages:
  - tasks:
    - name: template_example
      type: template
      template:
        inline: |
            Say {{.welcome}}

To create and run in Linux, Macos or Windows WSL

mkdir -p hello && cd hello
cat > .cirocket.yml << EOF
name: "sample mission"
params:
  - name: welcome
    value: hello world

stages:
  - tasks:
    - name: template_example
      type: template
      template:
        inline: |
          Say {{.welcome}}

EOF
cirocket launch --silent

Output

Say hello world