Skip to content

Repository files navigation

Codex LED Widget for macOS

A beautiful macOS desktop widget that shows your local Codex quota at a glance.

中文说明

Latest release License: MIT macOS

Codex LED Widget preview

Download

Download the latest DMG:

Download Codex LED Widget for macOS

Open the .dmg, drag Codex LED Widget into Applications, then launch it.

The release build is prepared for Apple Silicon, Intel Mac, and Universal macOS artifacts.

Why

If you use Codex heavily, checking the quota page again and again gets old fast. Codex LED Widget keeps the important quota state on your desktop:

  • Green: available, remaining quota is at least 10%.
  • Yellow: low, remaining quota is below 10%.
  • Red: exhausted, remaining quota is 0.
  • The widget turns green again automatically after the quota window resets.

Features

  • Reads local Codex quota through the Codex app-server.
  • Shows remaining quota for the active window.
  • Displays 5-hour and 7-day quota windows with reset countdowns.
  • Supports Free, Go, Plus, Pro, Business, Team, and Enterprise plan labels.
  • Supports Chinese and English UI.
  • Supports small, medium, and large widget sizes.
  • Stays on the desktop like a calendar or weather widget.
  • Collapses into a visible desktop pill instead of disappearing.
  • Refreshes automatically every 60 seconds, with a manual refresh action.
  • Supports GitHub Release based automatic updates in packaged builds.
  • Includes a macOS menu bar entry for restore, refresh, size, plan, and launch-at-login actions.

Privacy

Codex LED Widget reads quota information locally from your installed Codex app.

  • It does not collect your OpenAI account information.
  • It does not upload your OpenAI account information.
  • It does not save your OpenAI account information.
  • It does not display your token.
  • It does not expose Codex credentials in the UI.

The widget starts the local Codex app-server and calls:

account/rateLimits/read

Install

Option 1: Download a release

Download the latest .dmg from GitHub Releases, open it, and move the app to Applications.

If the release is signed and notarized, macOS should open it normally. If you are using an unsigned community build and macOS shows a first-run security prompt, open System Settings > Privacy & Security and allow the app to run.

Option 2: Homebrew Cask

Homebrew Cask support is prepared through homebrew/codex-led-widget.rb. After the Universal DMG is published to a tap, developer users will be able to install with:

brew install --cask codex-led-widget

Option 3: Run from source

npm install
npm start

If Codex is not installed at /Applications/Codex.app, set the Codex CLI path:

CODEX_CLI_PATH="/path/to/codex" npm start

Build

npm run build

Build artifacts are written to dist/.

Useful build commands:

npm run build          # signed Universal build when signing credentials are available
npm run build:unsigned # unsigned Universal build for local testing
npm run build:arm64    # Apple Silicon build
npm run build:x64      # Intel Mac build

Code signing and notarization

The project is configured for Apple Developer ID signing and notarization. Set these environment variables before building a public release:

export CSC_NAME="Developer ID Application: Your Name (TEAMID)"
export APPLE_ID="you@example.com"
export APPLE_APP_SPECIFIC_PASSWORD="xxxx-xxxx-xxxx-xxxx"
export APPLE_TEAM_ID="TEAMID"
npm run build

If these variables are missing, notarization is skipped so local development builds still work.

Use as a Codex Plugin

This repository is also structured as a Codex plugin. The plugin manifest lives at:

.codex-plugin/plugin.json

The plugin presents the macOS desktop widget, installation instructions, and release artifacts as a Codex-discoverable package.

Included Publishing Skill

This repository also includes a reusable Codex skill at:

skills/github-plugin-publisher

Use it when you want Codex to package a small app or plugin, write bilingual GitHub documentation, prepare release notes, configure repository metadata, and publish a public GitHub release.

Launch Plan

The public growth plan and ready-to-use launch copy live in:

GROWTH_PLAN.md
launch-copy/

Current Limitations

  • Universal, arm64, and x64 build scripts are configured; validate every release artifact on real hardware before publishing.
  • Public releases require a valid Apple Developer ID certificate and notarization credentials for the best macOS install experience.
  • The quota adapter depends on the local Codex app-server API. If Codex changes that API, the adapter may need an update.

Roadmap

  • Publish the Homebrew Cask through a tap.
  • Add an in-app update progress view.

License

MIT

Releases

Packages

Contributors

Languages