Skip to content

Repository files navigation

CodeXtock — Codex usage at a glance

A native Windows tray companion for Codex usage, quotas, tasks, and workflow activity.

English · 简体中文

Windows build Latest release GPL-3.0 license Windows 11

CodeXtock keeps the information you need beside the Windows clock: right-click the tray icon to see every available quota window, left-click to open a detailed dashboard, and optionally use Codex Hooks to follow live tasks. It is built with C#, .NET 10, WPF, and Win32 APIs for Windows 11.

Note

CodeXtock is a community project and is not an official OpenAI product. It supports native Windows Codex installations and does not include macOS, iCloud, WebDAV, or WSL bridging.

Preview

CodeXtock dashboard showing account, quota and usage activity CodeXtock tray menu showing quota cards
Dashboard — account, quota windows, token activity, and live tasks Tray menu — quota status without opening a window

What it does

Area Highlights
Tray at a glance Polished quota cards, remaining percentage, reset time, cached-state indicators, animated opening, and a dynamic quota ring on the tray icon.
Account and quota Account, plan, all rate-limit windows, Reset Credits, expiration details, and server-provided token activity. Unknown values stay unknown instead of being shown as zero.
Workflow activity Running and approval-waiting tasks, recent completions and interruptions, tool and sub-agent activity, longest task, streaks, and a 30-week heat map.
Hooks Twelve Codex Hook event types with minimal local metadata, safe handler merging, trust checks, and rebuildable daily statistics.
Windows integration Per-category notifications, global shortcut, launch at sign-in, multi-monitor task glow, keep-awake controls, low-battery protection, and scheduled wake for auto-reset.
Personalization Light and dark themes, English and Simplified Chinese UI, crisp high-DPI graphics, proxy modes, compact layouts down to 900×640, and selectable tray quota windows.

Requirements

  • Windows 11 on x64 or ARM64
  • A signed-in Codex CLI, or the bundled Codex installation from the ChatGPT/Codex Windows app
  • Codex app-server 0.145.0 or newer
  • Codex 0.150.0 or newer for Hooks and live task tracking

Release packages are self-contained; users do not need to install .NET. Building from source requires the .NET 10 SDK.

Install

  1. Open the latest release and download CodeXtock-win-x64.zip. ARM64 users can choose CodeXtock-win-arm64.zip when it is available.

  2. Download the matching .zip.sha256 file and verify the archive:

    $expected = (Get-Content .\CodeXtock-win-x64.zip.sha256).Split()[0]
    $actual = (Get-FileHash .\CodeXtock-win-x64.zip -Algorithm SHA256).Hash
    if ($actual -ne $expected) { throw "Checksum verification failed." }
  3. Extract the complete ZIP to a normal folder. Do not run it from File Explorer's ZIP preview.

  4. Open PowerShell in the extracted folder and run:

    Set-ExecutionPolicy -Scope Process Bypass
    .\Install-CodeXtock.ps1

The installer validates every packaged file, installs for the current user under %LOCALAPPDATA%\Programs\CodeXtock, creates a Start menu shortcut, and launches CodeXtock. Administrator rights are not required.

Unsigned community builds may trigger Microsoft Defender SmartScreen. Verify the release checksum before choosing to run the file.

First run

  1. Find the CodeXtock icon in the notification area. Windows may initially place it under the overflow arrow.
  2. Right-click the icon to inspect quota usage immediately; left-click to open the dashboard.
  3. Confirm that your account, plan, and quota windows load.
  4. Open Settings → Hooks and enable Hooks if you want live tasks and local workflow statistics. Review and trust the user Hook when Codex asks.
  5. Enable only the notifications, keep-awake behavior, glow effects, and auto-reset options you want. Auto-reset is off by default.

The default global shortcut is Ctrl+Alt+W. Language, theme, shortcut, tray display, and integration options can all be changed without reinstalling.

Documentation

Document English 简体中文
User guide Read 阅读
Installation and deployment Read 阅读
Privacy and local data Read 阅读
Architecture — 阅读
Implementation status — 阅读

See the documentation index for a topic-based overview.

Privacy and security

CodeXtock runs in the current Windows user account. It starts a local Codex app-server over stdio and does not call the OpenAI HTTP API directly. It does not read or store Codex access tokens, prompts, responses, tool arguments, or tool output. Hook processing retains only the metadata required for statistics and task state. Local settings and activity data live under:

%LOCALAPPDATA%\CodeXtock

Raw Hook events and daily aggregates are retained for up to 210 days by default. CodeXtock has no telemetry, advertising, cloud synchronization, or bundled update service. Custom proxy URLs containing credentials are rejected.

Auto-reset is the only feature that actively changes Codex account quota state, and it is disabled by default. Changing “Codex TUI notifications” writes that Codex preference after an explicit user action. See Privacy and Security Policy for the complete boundaries and reporting guidance.

Build from source

git clone https://github.com/mingxian233/CodeXtock.git
cd CodeXtock
dotnet build CodeXtock.slnx -c Release
dotnet run --project tests/CodeXtock.Tests/CodeXtock.Tests.csproj -c Release
dotnet run --project src/CodeXtock.App/CodeXtock.App.csproj -c Release

Create a tested, self-contained package:

Set-ExecutionPolicy -Scope Process Bypass
.\scripts\build-release.ps1 -Runtime win-x64 -Zip

Use win-arm64 for an ARM64 package. The release script rebuilds the product icon, builds all projects, runs the executable test suite, loads all four WPF theme/language combinations, publishes the application and Hook host, and creates file-level plus ZIP-level SHA-256 checksums.

The main projects are:

  • CodeXtock.Core — models, configuration, policy, and pure algorithms
  • CodeXtock.Codex — Codex discovery and app-server communication
  • CodeXtock.Activity — Hook ingestion, task state, and local statistics
  • CodeXtock.Platform.Windows — tray, notifications, power, shortcuts, startup, and scheduling
  • CodeXtock.App — WPF application and composition root
  • CodeXtock.HookHost — short-lived Hook event receiver
  • CodeXtock.Tests — offline executable test suite

Limits to know about

  • CodeXtock shows what the signed-in Codex app-server returns; some API-key-only accounts do not expose account-level quota fields.
  • Windows can override keep-awake requests for manual sleep, lid close, shutdown, organization policy, or some Modern Standby behavior.
  • Notifications use the Windows tray notification path and cannot be retracted from Notification Center after Windows accepts them.
  • There is currently no in-app updater. Install a newer release over the existing per-user installation.

License and acknowledgements

CodeXtock is released under the GNU General Public License v3.0. It is a Windows adaptation derived from the public design and GPL-3.0-licensed source of CodexBar. Upstream copyright belongs to its respective authors and contributors; details are preserved in NOTICE.md.

“OpenAI”, “ChatGPT”, and “Codex” are trademarks of their respective owners.

About

A polished native Windows tray companion for Codex quota, activity, and workflow insights.

Topics

Resources

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages