Skip to content
Vulcan CIVulcan CI

Getting started

From an empty repository to a green build in about five minutes.

Requirements

Section titled “Requirements”
  • An account in an organisation on a Vulcan CI instance.
  • git and a repository you can push to.
  • Linux or macOS on the machine running the CLI. Workers are provisioned by your platform admins — nothing to install for builds.

Install the CLI

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

Verify the install:

Terminal window
$ vulcan --version
vulcan 0.1.0

Authorise the CLI

Section titled “Authorise the CLI”
Terminal window
$ vulcan auth login --instance https://vulcan.example.com

This opens Forge in your browser. Sign in, approve the request, and the CLI stores a scoped API token in ~/.config/vulcan/credentials. Tokens can be reviewed and revoked at any time under Profile → My API tokens.

Register a project

Section titled “Register a project”

From the root of your repository:

Terminal window
$ vulcan init
Created .vulcan/workflows/ci.yaml
$ vulcan project register
Registered project payments-api in organisation acme

vulcan init writes a starter workflow; Workflow config covers every key. Commit the .vulcan/ directory — workflow definitions are versioned with your code.

Trigger your first build

Section titled “Trigger your first build”

Builds start on push by default. To trigger one by hand and follow it:

Terminal window
$ vulcan build trigger --workflow ci
Build #1 queued on pool default
$ vulcan build watch
ci / verify / unit … running 00:41

Open the build in Forge to see the workflow graph, per-step logs, and timing. The project page keeps a history strip of recent builds.

Next steps

Section titled “Next steps”