Skip to main content

gluon run

gluon run consumes a compiled plan and either previews or executes it.

Usage

gluon run --plan plan.json

Without --execute, run stays in dry-run mode.

Common examples

Execute the full plan locally:

gluon run --plan plan.json --execute --runner local

Execute inside Docker:

gluon run --plan plan.json --execute --runner docker

Force GitHub Actions compatibility mode:

gluon run --plan plan.json --execute --gha

Show full step logs instead of the compact summary view:

gluon run --plan plan.json --execute --verbose

Retry one failed job after clearing its saved state:

gluon run --plan plan.json --execute --job-id web-app@staging.deploy --retry

Override the working directory for every job:

gluon run --plan plan.json --execute --workdir ./examples

Flags

FlagMeaning
--plan, -pPath to the compiled plan file
--execute, -xActually execute commands instead of dry-running
--verboseExpand full step logs instead of the compact summary view
--workdirOverride the working directory for all jobs
--job-idRun only one job ID
--retryClear saved state for the selected --job-id before running
--runnerChoose local, docker, or github-actions
--ghaShortcut for --runner github-actions

Backend resolution

run chooses its backend in this order:

  1. --gha
  2. --runner
  3. GLUON_RUNNER
  4. GITHUB_ACTIONS=true
  5. Auto-detection when the plan contains a use: step
  6. Default to local

State files

Executed plans record progress in the configured state file, usually .gluon-state.json. That allows resumable execution and job-level retries while protecting against plan checksum mismatches.

By default, successful runs render a compact per-step view with summaries and results while collapsing noisy backend logs. Use --verbose when you need the raw step logs inline.