Skip to main content

A CLI and TUI for avios.com — view your Avios balance and transactions from the terminal.

Project description

avios-cli

CI License: MIT Python

A CLI and TUI for avios.com — check your Avios balance, browse your transactions and manage your account without leaving the terminal.

⚠️ Unofficial. This project is not affiliated with, authorised by, or endorsed by Avios, British Airways or IAG Loyalty. It drives the same private endpoints the avios.com website uses, with your own logged-in session. Use at your own risk; it may break at any time and may be against the provider's terms of service.

avios TUI dashboard

The avios tui dashboard (demo data). Regenerate with uv run python scripts/screenshot.py.

Status

Early alpha, built in the open. See the roadmap.

Install

Requires Python 3.10+.

uvx avios-cli --help     # run without installing
# or install it, then use the `avios` command:
pip install avios-cli
avios --help

Or from source, for development:

git clone https://github.com/alexechoi/avios-cli
cd avios-cli
uv sync
uv run avios --help

Log in

avios.com has no credential API — login is Auth0 Universal Login behind hCaptcha and SMS/passkey MFA — so avios login rides a real browser session (like gh/aws login). Login needs the login extra, so run it with avios-cli[login]:

# open a browser and log in once (first run also downloads Chromium):
uvx --from 'avios-cli[login]' playwright install chromium
uvx --from 'avios-cli[login]' avios login

# ...or skip the browser download and import the cookie from Chrome you're
# already logged into avios.com with:
uvx --from 'avios-cli[login]' avios login --from-browser

If you installed with pip install "avios-cli[login]", just run avios login (and playwright install chromium once). Plain uvx avios-cli login won't work — the isolated environment doesn't include the login extra.

Your session cookie is stored at ~/.config/avios/state.json (mode 600). It expires after ~a day; just run avios login again. Run avios logout to remove it.

Usage

avios balance                  # your Avios balance
avios transactions --limit 20  # recent transactions
avios pending                  # pending Avios
avios accounts                 # linked loyalty accounts
avios overview                 # dashboard summary (raw JSON)
avios whoami                   # your profile (raw JSON)
avios raw /manage-avios/api/user/current   # hit any endpoint directly

Add --json to balance, transactions, pending or accounts for scriptable output.

TUI

avios tui

A full-screen dashboard: your balance in the header and a scrollable transactions table. Press r to refresh, q to quit.

Roadmap

  • Project scaffolding, packaging and CI
  • Session + cookie storage layer
  • Typed API client (balance, transactions, accounts, profile)
  • Browser-assisted avios login
  • CLI commands
  • Textual TUI dashboard
  • Reward-flight availability search (coming soon — needs a British Airways capture)

Development

uv sync            # installs the project + the `dev` dependency-group
uv run ruff check .
uv run mypy src
uv run pytest

See CONTRIBUTING.md for the full workflow and CHANGELOG.md for release notes.

Security

No passwords are handled or stored — only your session cookie, kept locally at ~/.config/avios/state.json (mode 600). See SECURITY.md.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

avios_cli-0.1.2.tar.gz (104.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

avios_cli-0.1.2-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

Details for the file avios_cli-0.1.2.tar.gz.

File metadata

  • Download URL: avios_cli-0.1.2.tar.gz
  • Upload date:
  • Size: 104.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for avios_cli-0.1.2.tar.gz
Algorithm Hash digest
SHA256 1831a5138e75eb96e61cbef34858055f58e4a1aef0905f348f96f6b182234e2a
MD5 5a16d94b0629447a145a4534d34a17d5
BLAKE2b-256 a24bfec092850aea21da21a5103b28cf0b6f6d98b83a4988edd2cd832cd6a6ba

See more details on using hashes here.

Provenance

The following attestation bundles were made for avios_cli-0.1.2.tar.gz:

Publisher: publish.yml on alexechoi/avios-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avios_cli-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: avios_cli-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 17.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for avios_cli-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9d923852a335bff5f181f778b1d0e3a7f9f24be66a873dfe3cdbc44a89b5e242
MD5 c2b2ca9cba66cec459da998d2a329714
BLAKE2b-256 37018857a6dc1743ffdbc1ff865d7a03a4ea2a1fa27c486b153639626594782e

See more details on using hashes here.

Provenance

The following attestation bundles were made for avios_cli-0.1.2-py3-none-any.whl:

Publisher: publish.yml on alexechoi/avios-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page