$ cinder docs

Docs

Guides for building pipelines, running them on your own machines and wiring Cinder into everything else. Press Cmd+K or Ctrl+K at any time to search.

01

Get started

From sign up to a green check.

Quickstart

Run your first pipeline in about five minutes, from sign up to a green check.

4 min read

Install the CLI

Install the command line tool and sign in, on macOS, Linux or Windows.

3 min read

Your first pipeline

Build, test and deploy a small app with three steps and one condition.

6 min read

02

Pipelines and runners

Files, caches and machines.

Pipeline file reference

Every field in cinder.yml: steps, conditions, environment, timeouts and matrices.

9 min read

Caching dependencies

Restore installs from a cache keyed on your lockfile and save minutes on every run.

5 min read

Self-hosted runners

Run jobs on your own machines and route them with labels. Public beta.

6 min read

03

Integrations and API

Webhooks, secrets and the REST API.

Webhooks and signatures

Receive run events and verify that every delivery really came from Cinder.

7 min read

Secrets and environment

Store tokens safely, scope them to a branch and keep them out of your logs.

5 min read

REST API and tokens

Trigger runs, read results and manage pipelines with a token.

6 min read

Stuck? Ask the docs.

Ask a question in plain words and get an answer from these docs. AI support by Chatbase, a partner link: we may earn a commission if you sign up.

Create a free website with Framer, the website builder loved by startups, designers and agencies.