CLI reference
All commands take the form vulcan <command> [flags]. This page documents vulcan 0.1.
Global flags
Section titled “Global flags”| Flag | Description |
|---|---|
--instance <url> |
Vulcan CI instance. Defaults to the value stored by vulcan auth login. |
--org <slug> |
Organisation to act in. Defaults to the project’s organisation. |
--token <token> |
API token. Overrides stored credentials; intended for scripts. |
--json |
Machine-readable output on stdout. |
-q, --quiet |
Suppress progress output; exit code carries the result. |
vulcan init
Section titled “vulcan init”Write a starter workflow into .vulcan/workflows/ci.yaml. Safe to run in an existing project — it never overwrites.
$ vulcan init [--workflow <name>] [--pool <pool>]vulcan project
Section titled “vulcan project”$ vulcan project register [--name <name>]$ vulcan project list$ vulcan project archive <name>| Command | Description |
|---|---|
register |
Register the current repository as a project. Name defaults to the repository directory. |
list |
Projects in the organisation, with last build status. |
archive |
Hide a project and stop accepting new builds. Reversible in Forge. |
vulcan build
Section titled “vulcan build”$ vulcan build trigger [--workflow <name>] [--ref <ref>]$ vulcan build watch [<id>]$ vulcan build cancel <id>$ vulcan build logs <id> [--step <name>]| Command | Description |
|---|---|
trigger |
Queue a build. --ref defaults to the current HEAD; the commit must be pushed. |
watch |
Stream live step status. Without an id, follows the most recent build. |
cancel |
Stop a pending or running build. Running steps receive SIGTERM, then SIGKILL after 10s. |
logs |
Print step logs. Add --follow while the build is running. |
vulcan token
Section titled “vulcan token”$ vulcan token create --label <label> [--expires <30d>]$ vulcan token list$ vulcan token revoke <id>Tokens created here appear under Profile → My API tokens in Forge. The secret is printed once, on creation, and never again.
vulcan auth
Section titled “vulcan auth”$ vulcan auth login [--instance <url>]$ vulcan auth logout$ vulcan auth statuslogin opens Forge to authorise the CLI and stores a scoped token locally. status prints the signed-in user, organisation, and token expiry.