Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 29 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Brain Usage

GNOME Shell extension that tracks your AI usage limits for **Claude** (Anthropic) and **Codex/ChatGPT** (OpenAI) and displays remaining percentages in the top panel.
GNOME Shell extension that tracks your AI usage limits for **Claude** (Anthropic) and **Codex/ChatGPT** (OpenAI) and displays remaining/used percentages in the top panel.

![GNOME Shell 45+](https://img.shields.io/badge/GNOME_Shell-45--49-blue)
![License: MIT](https://img.shields.io/badge/License-MIT-green)
Expand All @@ -9,7 +9,9 @@ GNOME Shell extension that tracks your AI usage limits for **Claude** (Anthropic

- Session and weekly usage tracking for Claude and Codex
- Color-coded progress bars (green / yellow / red) based on remaining percentage
- Configurable panel label: show minimum across all, or a specific window
- Configurable panel display: show any combination of Claude/Codex session and week values
- Provider icons in the panel and popup
- Toggle the panel percentage between remaining and used
- Desktop notifications when usage drops below 20%
- Auto-refresh every 3 minutes with manual refresh option
- Dark theme with modern card-based popup design
Expand All @@ -30,6 +32,7 @@ These credential files are created automatically when you sign in to the respect
1. Download the latest `brainusage@altairinglorious.shell-extension.zip` from [Releases](https://github.com/AltairInglorious/brainusage/releases/latest)

2. Install via terminal:

```bash
gnome-extensions install --force brainusage@altairinglorious.shell-extension.zip
```
Expand Down Expand Up @@ -58,22 +61,37 @@ bash scripts/dev/enable.sh

Once enabled, a percentage indicator appears in the top panel. Click it to see a detailed breakdown:

- **Session** and **Weekly** usage for each provider
- **Session** and **Weekly** usage windows for each provider in the popup
- Progress bars with color-coded status
- Time until each window resets
- Next automatic update countdown

### Panel display modes

Right-click or open the popup and select **Panel display** to choose what the top-bar label shows:
Open the popup and use the **Panel metrics** switches to choose which top-bar values are shown:

| Mode | Description |
| -------------- | --------------------------------- |
| Claude Session | Claude session value in the panel |
| Claude Week | Claude week value in the panel |
| Codex Session | Codex session value in the panel |
| Codex Week | Codex week value in the panel |

You can enable more than one of these at the same time, including all four values.

### Panel label style

Open the **Label style** submenu to choose how the panel names its metrics:

- **Compact**: abbreviated labels (`s`, `w`)
- **Expanded**: full labels (`Session`, `Week`)

### Panel percent mode

Open the **Percent mode** submenu to choose whether the top-bar value shows:

| Mode | Description |
|------|-------------|
| All (minimum) | Lowest percentage across all windows |
| Claude Session | Claude session usage only |
| Claude Weekly | Claude weekly usage only |
| Codex Session | Codex session usage only |
| Codex Weekly | Codex weekly usage only |
- **Left**: remaining percentage for every selected panel metric
- **Used**: used percentage for every selected panel metric

## Development

Expand Down
7 changes: 7 additions & 0 deletions extension/assets/claude-symbolic.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions extension/assets/codex-symbolic.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading