quick-start.md

Start by configuring the Cirrus CI application from GitHub Marketplace.

Choose a plan for your personal account or for an organization you have admin writes for.

GitHub Apps can be installed on all repositories or on repository-by-repository basis for granular access control. For example, Cirrus CI can be installed only on public repositories and will only have access to these public repositories. In contrast, classic OAuth Apps don't have such restrictions.

!!! note "Change Repository Access" You can always revisit Cirrus CI's repository access settings on your installation page.

Post Installation

Once Cirrus CI is installed for a particular repository, a .cirrus.yml configuration file should be added to the root of the repository. The .cirrus.yml defines tasks that will be executed for every build for the repository.

For a simple Node.js project, your .cirrus.yml can look like:

container:
  image: node:latest

check_task:
  node_modules_cache:
    folder: node_modules
    fingerprint_script: cat yarn.lock
    populate_script: yarn install
  test_script: yarn test

That's all! After pushing a .cirrus.yml a build with all the tasks defined in the .cirrus.yml file will be created.

!!! tip "Zero-config Docker Builds" If your repository happened to have a Dockerfile in the root, Cirrus CI will attempt to build it even without a corresponding .cirrus.yml configuration file.

You will see all your Cirrus CI builds on cirrus-ci.com once signing in.

GitHub status checks for each task will appear on GitHub as well.

Newly created PRs will also get Cirrus CI's status checks.

!!! info "Examples" Don't forget to check examples page for ready-to-copy examples of some .cirrus.yml configuration files for different languages and build systems.

!!! info "Life of a build" Please check a high level overview of what's happening under the hood when a changed is pushed and this guide to learn more about how to write tasks.