Skip to content
 
 

Repository files navigation

Codex Usage GNOME Extension

Display OpenAI Codex usage in the GNOME Shell top panel.

Forked from claude-usage-extension by Haletran. Now maintained by kevinpita.

What It Shows

  • Shows current 5-hour usage in the top panel
  • Displays 5-hour, weekly, and Codex Spark usage in the dropdown menu
  • Shows reset countdowns and last refresh time
  • Supports text, progress bar, or both
  • Can show used or remaining percentages
  • Includes configurable refresh interval, icon style, and optional HTTP proxy
  • Falls back to recent ~/.codex/sessions logs when ChatGPT backend usage endpoints reject headless requests

Requirements

  • GNOME Shell 46, 47, 48, 49, or 50
  • Codex CLI installed and authenticated so ~/.codex/auth.json exists

Installation

Quick Deploy

From the repository root:

./update

The script copies this repo to:

~/.local/share/gnome-shell/extensions/codex-usage@kevinpita.dev

It then recompiles the GSettings schema and ends the current GNOME session with gnome-session-quit --no-prompt, so save your work first.

After logging back in, enable the extension if needed:

gnome-extensions enable codex-usage@kevinpita.dev

Manual Installation

From the repository root:

install_dir="$HOME/.local/share/gnome-shell/extensions/codex-usage@kevinpita.dev"

rm -rf "$install_dir"
mkdir -p "$(dirname "$install_dir")"
cp -rT "$PWD" "$install_dir"
glib-compile-schemas "$install_dir/schemas"
gnome-extensions enable codex-usage@kevinpita.dev

Reload GNOME Shell after installation:

  • X11: press Alt+F2, type r, then press Enter
  • Wayland: log out and log back in

Notes

The extension reads authentication from ~/.codex/auth.json or $CODEX_HOME/auth.json, then requests usage from:

  • https://chatgpt.com/backend-api/codex/usage
  • https://chatgpt.com/backend-api/wham/usage

If both endpoints fail, it reads recent local Codex session logs from ~/.codex/sessions and uses the last emitted rate_limits payload.

Proxy URLs must use standard authority order:

http://user:password@host:port

If the proxy field is empty, the extension checks CODEX_USAGE_PROXY_URL, then the local Codex Desktop proxy forwarder at http://127.0.0.1:18080 when its user systemd service exists, then standard HTTPS_PROXY / HTTP_PROXY environment variables.

Disclaimer

This extension is not affiliated with, funded by, or associated with OpenAI.

About

GNOME Shell extension that displays your Codex usage percentage

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages