Skip to content

User docs

Everything for developers working in an organisation on Vulcan CI: registering projects, defining workflows, and working with builds — from the CLI, the API, or Forge.

Getting started takes you from an empty repository to a green build: install the CLI, authorise it, register a project, trigger a build.

Terminal window
$ vulcan init
$ vulcan project register
  • Workflows — pipeline definitions: phases, steps, dependencies, triggers, and where builds run.
  • CLI — 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.

Operating the platform itself — automata, pools, admission, tokens — lives in the admin docs.