Skip to content
| Docs

CLI Reference

avr is the Avrea command-line client. Avrea on the command line.

Synopsis

Section titled “Synopsis”
Terminal window
avr [GLOBAL OPTIONS] COMMAND [ARGS]...

Global options

  • --version, -V — Show the version and exit.
  • --no-color — Disable colored output. Also honors NO_COLOR=1.
  • --verbose, -v — Show debug information including HTTP requests.
  • --links / --no-links — Make IDs clickable via OSC 8 hyperlinks. Auto-disabled off-TTY. Also honors AVR_LINKS=0. (default: True · env: AVR_LINKS)

Commands

Section titled “Commands”

Core Commands

Section titled “Core Commands”
  • avr status — Show recent runs, performance stats, and cache health.
  • avr run — View and manage GitHub workflow runs.
  • avr job — Inspect Avrea job VMs (SSH, metrics, logs).
  • avr workflow — List and view workflow definitions.
  • avr cache — Inspect and manage the Avrea build cache.
  • avr log — Search across runner execution logs.

Setup & Config

Section titled “Setup & Config”
  • avr auth — Authenticate and manage credentials.
  • avr config — View and manage CLI configuration.
  • avr settings — View and toggle cache and runner settings.
  • avr billing — Manage billing, invoices, and payment methods.
  • avr audit-events — View audit events for organization writes.

Additional Commands

Section titled “Additional Commands”
  • avr repo — List repositories connected to Avrea.
  • avr org — Manage organizations and installations.
  • avr health — Check Avrea platform status.

Aliases

Section titled “Aliases”