Skip to content

avr run

View and manage GitHub workflow runs.

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

Cancel an in-progress or queued workflow run.

Terminal window
avr run cancel [OPTIONS] RUN_ID
Terminal window
Examples:
avr run cancel run-abc123
avr run cancel run-abc123 --yes

Arguments

  • RUN_ID

Options

  • --org <TEXT> — Organization ID.
  • -y, --yes — Skip the confirmation prompt.

List workflow runs for an organization.

Terminal window
avr run list [OPTIONS]
Terminal window
Examples:
avr run list
avr run list --status failure --limit 5
avr run list --status in_progress --json status,conclusion,head_branch
avr run list --branch main --status completed
avr run list --since 24h
avr run list --json '?' # list available fields
avr run list --json '*' # all fields
avr run list --json status,conclusion -q '[.[] | select(.status == "completed")]'
Terminal window
JSON FIELDS
conclusion, created_at, display_title, duration_seconds, event,
head_branch, head_sha, platform_run_id, repository, run_attempt, run_id,
run_number, status, triggering_actor, updated_at, workflow, 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, repeatable). Auto-detected from git remote if omitted. (repeatable)
  • --status <CHOICE> — Filter by state (queued, in_progress, completed) or conclusion (success, failure, ...). Repeatable. (choices: action_required, cancelled, completed, failure, in_progress, neutral, queued, skipped, stale, startup_failure, success, timed_out · repeatable)
  • --branch <TEXT> — Filter by head branch (repeatable). (repeatable)
  • -w, --workflow <TEXT> — Filter by workflow ID (wfl-xxx, repeatable). (repeatable)
  • --since <TEXT> — Relative time window: '7d', '24h', etc. Sugar for --created-after.
  • --from, --created-after <TEXT> — Only runs created after this ISO timestamp.
  • --to, --created-before <TEXT> — Only runs created before this ISO timestamp.
  • -L, --limit <INTEGER RANGE> — Max runs to return. (default: 20)
  • --cursor <TEXT> — Pagination cursor from a previous response.
  • --order <CHOICE> — Sort order. (choices: created_at.desc, created_at.asc · default: created_at.desc)
  • --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.

Fetch logs for a workflow run's GitHub jobs.

Terminal window
avr run logs [OPTIONS] RUN_ID

Long-form alternative to avr run view --log[-failed]. Use --follow to tail logs in real time for an in-progress job; pass --job to scope to a specific job when a run has many.

Terminal window
Examples:
avr run logs run-abc123
avr run logs run-abc123 --failed
avr run logs run-abc123 --job test
avr run logs run-abc123 --follow

Arguments

  • RUN_ID

Options

  • --org <TEXT> — Organization ID.
  • --job <TEXT> — Restrict to GitHub jobs whose name contains this string.
  • -f, --follow — Tail logs as they appear (running jobs only).
  • --failed — Show only logs from failed jobs.
  • --all-levels — Include diagnostic-level lines (off by default).
  • --no-pager — Print directly to stdout instead of paging through less. Same as setting AVR_PAGER=''.

Re-run a completed workflow run.

Terminal window
avr run rerun [OPTIONS] RUN_ID
Terminal window
Examples:
avr run rerun run-abc123
avr run rerun run-abc123 --failed
avr run rerun run-abc123 --yes

Arguments

  • RUN_ID

Options

  • --org <TEXT> — Organization ID.
  • --failed — Re-run only the failed jobs.
  • -y, --yes — Skip the confirmation prompt.

View a workflow run with its jobs.

Terminal window
avr run view [OPTIONS] [RUN_ID]
Terminal window
Without RUN_ID, shows 10 most recent runs.
Terminal window
Examples:
avr run view
avr run view run-abc123
avr run view run-abc123 --steps
avr run view run-abc123 --log-failed
avr run view run-abc123 --job Build
avr run view run-abc123 --json conclusion,jobs
avr run view run-abc123 --json '*' --jq '.jobs[].job_name'
Terminal window
JSON FIELDS
conclusion, created_at, display_title, duration_seconds, event,
head_branch, head_sha, jobs, platform_run_id, repository, run_attempt,
run_id, run_number, status, triggering_actor, updated_at, workflow,
workflow_id

Arguments

  • [RUN_ID]

Options

  • --org <TEXT> — Organization ID.
  • --steps — Expand each job to show its individual steps.
  • --log — Print full logs for all jobs.
  • --log-failed — Print logs only for failed steps.
  • --job <TEXT> — Restrict view and logs to jobs whose name contains this string.
  • --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.
  • --no-pager — Print logs directly to stdout instead of paging through less. Same as setting AVR_PAGER=''.

Watch a workflow run until it completes.

Terminal window
avr run watch [OPTIONS] [RUN_ID]
Terminal window
Without RUN_ID, auto-selects the latest in-progress run. Pass --repo
(repeatable) to scope the auto-select to specific repositories.
Terminal window
Examples:
avr run watch
avr run watch --repo avrea-com/avrea-core
avr run watch --repo a/x --repo b/y
avr run watch run-abc123 --exit-status
avr run watch run-abc123 --ndjson | jq -c .

Arguments

  • [RUN_ID]

Options

  • --org <TEXT> — Organization ID.
  • --repo <TEXT> — Scope the auto-select to a repo (org/name or rep-xxx, repeatable). Auto-detected from git remote if omitted. (repeatable)
  • --exit-status — Exit non-zero if run failed.
  • --interval <INTEGER> — Refresh interval in seconds. (default: 3)
  • --ndjson — Force NDJSON event stream (default when stdout isn't a TTY).