Skip to content
2 min read

fj workflow

Manage workflow definitions (trigger a workflow_dispatch)

fj workflow [OPTIONS] <COMMAND>

Every command also accepts the global flags: --host, --debug, --no-pager, --json-fields.

Options

  • --color <COLOR> — When to use ANSI color in output [default: auto][possible values: auto, always, never]

fj workflow list

List workflow files in the repo

fj workflow list [OPTIONS]

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • --json — Emit JSON instead of a table
  • --color <COLOR> — When to use ANSI color in output [default: auto][possible values: auto, always, never]

fj workflow run

Trigger a workflow_dispatch run of a workflow file

fj workflow run [OPTIONS] <WORKFLOW>

Arguments

  • <WORKFLOW> — Workflow file name, e.g. ci.yml

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • --ref <REF> — Git ref (branch or tag) to run on. Defaults to the repo’s default branch
  • --color <COLOR> — When to use ANSI color in output [default: auto][possible values: auto, always, never]
  • -f, --field <FIELDS> — Workflow input as key=value (repeatable)
  • --json — Emit JSON describing the triggered run
  • --watch — Stream the triggered run’s logs live until it finishes
  • -j, --job <JOB> — Job index within the run to watch (0-based) [default: 0]
  • -i, --interval <INTERVAL> — Seconds between polls while the job is running [default: 3]
  • --exit-status — Exit with status 1 unless the run conclusion is success or skipped

fj workflow enable

Enable a workflow file

fj workflow enable [OPTIONS] <WORKFLOW>

Arguments

  • <WORKFLOW> — Workflow file name, e.g. ci.yml

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • --color <COLOR> — When to use ANSI color in output [default: auto][possible values: auto, always, never]

fj workflow disable

Disable a workflow file

fj workflow disable [OPTIONS] <WORKFLOW>

Arguments

  • <WORKFLOW> — Workflow file name, e.g. ci.yml

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • --color <COLOR> — When to use ANSI color in output [default: auto][possible values: auto, always, never]

fj workflow view

View workflow metadata and state

fj workflow view [OPTIONS] <WORKFLOW>

Arguments

  • <WORKFLOW> — Workflow file name, e.g. ci.yml

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • --json — Emit JSON instead of a table
  • --color <COLOR> — When to use ANSI color in output [default: auto][possible values: auto, always, never]
Contributors
  • Stephen Way