Skip to content

avr workflow

List and view workflow definitions.

Terminal window
avr workflow [OPTIONS] COMMAND [ARGS]...

List workflows with aggregate run stats.

Terminal window
avr workflow list [OPTIONS]
Terminal window
Examples:
avr workflow list
avr workflow list --repo avrea-com/avrea-core
avr workflow list --since 7d
avr workflow list --limit 5
avr workflow list --since all
avr workflow list --json name,runs,median_duration_seconds
Terminal window
JSON FIELDS
completed_runs, failure_count, flaked_count, median_duration_seconds, name,
path, platform_workflow_id, repository, runs, workflow_id

Options

  • --org <TEXT> — Organization ID. Uses default org if not specified (see: avr config set org).
  • --repo <TEXT> — Filter by repository (org/repo or rep-xxx ID, repeatable). (repeatable)
  • --since <TEXT> — Time window: '30d', '7d', '24h', or 'all'. (default: 30d)
  • -L, --limit <INTEGER RANGE> — Max workflows to show. (default: 20)
  • --json <TEXT> — Output JSON. Pass comma-separated field names, "*" for all fields, or "?" to list available fields.
  • -q, --jq <TEXT> — Filter --json output through a jq expression.

Trigger a workflow_dispatch event.

Terminal window
avr workflow run [OPTIONS] WORKFLOW

WORKFLOW can be an Avrea workflow ID (wfl-...), a GitHub numeric workflow ID, a workflow filename (build.yml), or the workflow's display name.

Terminal window
Examples:
avr workflow run build.yml
avr workflow run "Build and Deploy" --ref feat/x
avr workflow run wfl-abc123 -f env=prod -f region=eu
echo '{"env":"prod"}' | avr workflow run build.yml --json
avr workflow run build.yml --watch --exit-status

Arguments

  • WORKFLOW_IDENTIFIER

Options

  • --org <TEXT> — Organization ID.
  • --repo <TEXT> — Repository (org/repo or rep-xxx). Auto-detected from git remote if omitted.
  • -r, --ref <TEXT> — Branch or tag to run at. Defaults to the repository's default branch.
  • -f, --raw-field <TEXT> — Workflow input: key=value (repeatable). (repeatable)
  • --json — Read a JSON object of inputs from stdin.
  • -w, --watch / -W, --no-watch — Poll for the new run and watch it until completion. Pass --no-watch / -W to return immediately. (default: True)
  • --exit-status — With --watch, exit non-zero if the run failed.
  • --interval <INTEGER> — With --watch, refresh interval in seconds. (default: 3)

View a workflow with aggregate stats and per-job breakdown.

Terminal window
avr workflow view [OPTIONS] WORKFLOW

WORKFLOW can be an Avrea workflow ID (wfl-...), a GitHub numeric workflow ID (the integer in the GH URL), a workflow filename (build.yml), or the workflow's display name. All forms except wfl-... need a repository — pass --repo or run from inside the repo's git checkout.

Terminal window
Examples:
avr workflow view wfl-abc123
avr workflow view 200589168
avr workflow view ci.yml
avr workflow view "Build and Deploy" --since 7d
avr workflow view ci --json runs,median_duration_seconds
avr workflow view wfl-abc123 --json '*' --jq '.jobs[].job.name'
Terminal window
JSON FIELDS
completed_runs, failure_count, flaked_count, jobs, median_duration_seconds,
name, p95_duration_seconds, path, platform_workflow_id, repository, runs,
workflow_id

Arguments

  • WORKFLOW_IDENTIFIER

Options

  • --org <TEXT> — Organization ID.
  • --repo <TEXT> — Repository (org/repo or rep-xxx). Auto-detected from git remote when WORKFLOW is a filename or display name.
  • --since <TEXT> — Time window: '30d', '7d', '24h', or 'all'. (default: 30d)
  • --json <TEXT> — Output JSON. Pass comma-separated field names, "*" for all fields, or "?" to list available fields.
  • -q, --jq <TEXT> — Filter --json output through a jq expression.
  • --web — Open in browser.