Skip to content
Vulcan CIVulcan CI

Documentation

Continuous integration for organisations that run their own metal. Forge is the web UI; `vulcan` is the CLI.
User docs

Register projects, define workflows, trigger and watch builds, manage API tokens.

Getting started →Admin docs

Operate the platform: automata, pools, worker admission, enrollment tokens, delivery log.

Administration →

Quick start

Section titled “Quick start”
Terminal window
# install the CLI
$ curl -sSf https://get.vulcan-ci.io | sh


# authorise the CLI against your instance
$ vulcan auth login


# register the current repository as a project
$ vulcan init
$ vulcan project register

Getting started

Install, authorise, and run your first build.

Workflows

Phases, steps, dependencies, and triggers.

CLI reference

Every vulcan command and flag.

Workflow config

The .vulcan/workflows YAML schema.

HTTP API

Projects and builds over REST, token-authenticated.

Changelog

Release notes across latest, stable, and dev.