Skip to main content

CLI tool to track OpenAI Codex usage with multi-account support

Project description

codex-usage

CLI tool to track OpenAI Codex usage with multi-account support and automatic account cycling.

Features

  • Usage Tracking: Check 5-hour and weekly usage limits for Codex CLI accounts
  • Multi-Account Management: Add, switch, remove, and list multiple Codex accounts
  • Automatic Cycling: Automatically switch accounts when usage limits are exhausted
  • Multiple Output Formats: Table, JSON, and compact oneline formats
  • Caching: 5-minute cache to reduce API calls

Installation

macOS

# Using Homebrew (coming soon)
brew install Liam-Deacon/tap/codex-usage

Linux

# Download from releases
curl -L https://github.com/Liam-Deacon/codex-usage/releases/latest/download/codex-usage-x86_64-unknown-linux-gnu -o codex-usage
chmod +x codex-usage
sudo mv codex-usage /usr/local/bin/

Windows

# Using Scoop (coming soon)
scoop bucket add Liam-Deacon https://github.com/Liam-Deacon/scoop-bucket
scoop install codex-usage

Node.js (npx / bunx)

npx codex-usage-cli --help
bunx codex-usage-cli --help

Python (uvx)

uvx codex-usage --help

Docker

docker pull ghcr.io/liam-deacon/codex-usage:latest
docker run --rm ghcr.io/liam-deacon/codex-usage:latest --help

Build from Source

cargo build --release
sudo cp target/release/codex-usage /usr/local/bin/

Quick Start

  1. Login to Codex (if not already):

    codex login
    
  2. Add your account:

    codex-usage accounts add myaccount
    
  3. Check usage:

    codex-usage status
    

Usage

Check Usage

# Check active account usage
codex-usage status

# Check all connected accounts
codex-usage status --all

# Output as JSON
codex-usage status --json

# Compact oneline output
codex-usage status --oneline

# Force refresh (skip cache)
codex-usage status --refresh

Account Management

# List all connected accounts
codex-usage accounts list

# Add current Codex auth as new account
codex-usage accounts add myaccount

# Switch to another account
codex-usage accounts switch myaccount

# Switch with force (override safety check)
codex-usage accounts switch myaccount --force

# Remove an account
codex-usage accounts remove myaccount

Automatic Cycling

Configure automatic account switching when usage limits are exhausted:

# Show cycle status
codex-usage cycle status

# Configure thresholds
codex-usage cycle config --five-hour 0 --weekly 10 --mode or

# Enable cycling
codex-usage cycle enable

# Disable cycling
codex-usage cycle disable

# Manually trigger cycle check
codex-usage cycle now

# View cycle history
codex-usage cycle history

# Reorder accounts in cycle
codex-usage cycle reorder account1 account2 account3

Wakeup

Trigger Codex to utilize daily/weekly limits:

# Run wakeup now
codex-usage wakeup --run

# Run wakeup for specific account
codex-usage wakeup --run --account myaccount

# Force wake even if Codex is running
codex-usage wakeup --run --force

# Install wakeup schedule (e.g., daily at 8am and 2pm)
codex-usage wakeup install --at 08:00 --at 14:00

# Install with interval between --at times
codex-usage wakeup install --at 08:00 --interval 1h

# List current wakeup schedules
codex-usage wakeup list

# Remove wakeup schedule
codex-usage wakeup remove

# Attempt to wake system from sleep (macOS)
codex-usage wakeup --run --wake-system

Watch

Continuously monitor usage with live updates:

# Watch active account (default 10s interval)
codex-usage watch

# Watch with custom interval
codex-usage watch --interval 30s

# Watch all accounts
codex-usage watch --all

# Force refresh on each poll (skip cache)
codex-usage watch --refresh

History

Track and analyze usage over time:

# Manage background recording daemon
codex-usage history daemon start --interval 5m
codex-usage history daemon stop
codex-usage history daemon status

# Show usage history
codex-usage history show
codex-usage history show --period week
codex-usage history show --from 2025-01-01 --to 2025-01-31
codex-usage history show --account myaccount

# Show terminal bar chart
codex-usage history chart
codex-usage history chart account1 account2

# Show allowance analysis
codex-usage history allowance
codex-usage history allowance --projected
codex-usage history allowance --dead-time

# Configure notifications
codex-usage history notify --enable
codex-usage history notify --disable
codex-usage history notify --hours-before 2
codex-usage history notify --status

# Export history data
codex-usage history export
codex-usage history export --output usage.json
codex-usage history export --period month --format json

Configuration

Config Directory

Default: ~/.codex-usage/

Override with:

codex-usage --config-dir /path/to/config status

Or set environment variable:

export CODEX_USAGE_DIR=/path/to/config

Files

  • config.json - Main configuration
  • accounts/ - Stored account auth files
  • cycle.json - Cycle configuration
  • cycle_history.jsonl - Cycle history
  • usage_cache.json - Usage data cache
  • wakeup.json - Wakeup configuration

Environment Variables

Variable Description
CODEX_USAGE_DIR Override config directory
CODEX_USAGE_VERBOSE Enable verbose logging

License

MIT License - see LICENSE file.

Related

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

codex_usage-0.1.10.tar.gz (79.2 kB view details)

Uploaded Source

Built Distributions

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

codex_usage-0.1.10-cp38-abi3-win_amd64.whl (2.6 MB view details)

Uploaded CPython 3.8+Windows x86-64

codex_usage-0.1.10-cp38-abi3-manylinux_2_39_x86_64.whl (2.9 MB view details)

Uploaded CPython 3.8+manylinux: glibc 2.39+ x86-64

codex_usage-0.1.10-cp38-abi3-macosx_11_0_arm64.whl (2.5 MB view details)

Uploaded CPython 3.8+macOS 11.0+ ARM64

codex_usage-0.1.10-cp38-abi3-macosx_10_12_x86_64.whl (2.7 MB view details)

Uploaded CPython 3.8+macOS 10.12+ x86-64

File details

Details for the file codex_usage-0.1.10.tar.gz.

File metadata

  • Download URL: codex_usage-0.1.10.tar.gz
  • Upload date:
  • Size: 79.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for codex_usage-0.1.10.tar.gz
Algorithm Hash digest
SHA256 7c2d5399e6ed98b61671eff1655a51ccf31b9c45d8fdc5700a66c77d1968bd26
MD5 06ef4b3ca9c0c3ba72d3e4edc4396bfa
BLAKE2b-256 8587953a38bfb2d643d9a602f4fd162e500277363523abcd54478b70a6b7199b

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_usage-0.1.10.tar.gz:

Publisher: pypi.yaml on Liam-Deacon/codex-usage

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

File details

Details for the file codex_usage-0.1.10-cp38-abi3-win_amd64.whl.

File metadata

  • Download URL: codex_usage-0.1.10-cp38-abi3-win_amd64.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: CPython 3.8+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for codex_usage-0.1.10-cp38-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 e6bcb6ccbf2531e1fd9e337308d4b69fbb7b224802917e091aeb325d669db986
MD5 3e22fea42ec866231e8baf0bb2c4b52d
BLAKE2b-256 e37723027d4bacab471ebda3b99ed5b4fc5214675800c5900d04b58a921db2ab

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_usage-0.1.10-cp38-abi3-win_amd64.whl:

Publisher: pypi.yaml on Liam-Deacon/codex-usage

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

File details

Details for the file codex_usage-0.1.10-cp38-abi3-manylinux_2_39_x86_64.whl.

File metadata

File hashes

Hashes for codex_usage-0.1.10-cp38-abi3-manylinux_2_39_x86_64.whl
Algorithm Hash digest
SHA256 51143bad80f7398b7bc79f0a72985ce3a4dc864334d37b50d56eb9c1681878b9
MD5 67c88fb14380443f427f044b941244b6
BLAKE2b-256 c91f1c281cbffceba253eac5ddaabcced723402f0eb8686cda6f72ac986aabd1

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_usage-0.1.10-cp38-abi3-manylinux_2_39_x86_64.whl:

Publisher: pypi.yaml on Liam-Deacon/codex-usage

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

File details

Details for the file codex_usage-0.1.10-cp38-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for codex_usage-0.1.10-cp38-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b86a1ee4ed4e82e3600e772e297cb4b4476755e9bc349487b1351af3f4adb787
MD5 4d867ad041e69ab04edb414224929098
BLAKE2b-256 6003f67fb8bd14e49a8e1be3466fb071694eec3e5a87a84bc6636d88652b6478

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_usage-0.1.10-cp38-abi3-macosx_11_0_arm64.whl:

Publisher: pypi.yaml on Liam-Deacon/codex-usage

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

File details

Details for the file codex_usage-0.1.10-cp38-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for codex_usage-0.1.10-cp38-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 a368a847c6ba5bb8e029114fc318bfc43eacd28a0b3872df724d70a4e13f515c
MD5 042266e2cc2c80d9456c5713729b18d5
BLAKE2b-256 56ac42cd349fd9358d87f7ffb57348418c9f4190b4653beef7e3826c5d112560

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_usage-0.1.10-cp38-abi3-macosx_10_12_x86_64.whl:

Publisher: pypi.yaml on Liam-Deacon/codex-usage

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