|
2 | 2 |
|
3 | 3 | Terminal dashboard to monitor Claude Code and Codex usage limits. |
4 | 4 |
|
5 | | -## Install |
6 | | - |
7 | | -### Via npm (requires Bun) |
| 5 | +## Quickstart |
8 | 6 |
|
9 | 7 | ```bash |
10 | 8 | npm install -g agent-limit |
| 9 | +agent-limit usage |
11 | 10 | ``` |
12 | 11 |
|
13 | | -### Standalone Binary (no dependencies) |
14 | | - |
15 | | -Download from [GitHub Releases](https://github.com/AgentWorkforce/limit/releases): |
16 | | - |
17 | | -```bash |
18 | | -# Apple Silicon |
19 | | -curl -L https://github.com/AgentWorkforce/limit/releases/latest/download/agent-limit-darwin-arm64 -o /usr/local/bin/agent-limit |
20 | | -chmod +x /usr/local/bin/agent-limit |
| 12 | +## Example |
21 | 13 |
|
22 | | -# Intel Mac |
23 | | -curl -L https://github.com/AgentWorkforce/limit/releases/latest/download/agent-limit-darwin-x64 -o /usr/local/bin/agent-limit |
24 | | -chmod +x /usr/local/bin/agent-limit |
| 14 | +``` |
| 15 | +[███████░░░░|░░░░░░░░░] 30% ↓12% |
| 16 | + ^ you should be at 42%, but you're at 30% (12% under pace) |
25 | 17 | ``` |
26 | 18 |
|
27 | | -## Quick Start |
| 19 | +- `↓X%` (green) = under pace, you have headroom |
| 20 | +- `↑X%` (red) = over pace, might hit limits early |
28 | 21 |
|
29 | | -```bash |
30 | | -agent-limit usage |
31 | | -``` |
| 22 | +## Features |
| 23 | + |
| 24 | +- Real-time usage tracking for Claude Code and Codex |
| 25 | +- Trajectory markers showing if you're ahead or behind your usage pace |
| 26 | +- Auto-refresh every 60 seconds |
| 27 | +- Color-coded usage indicators |
32 | 28 |
|
33 | | -## CLI |
| 29 | +## CLI Reference |
34 | 30 |
|
35 | 31 | | Command | Description | |
36 | 32 | |---------|-------------| |
37 | 33 | | `agent-limit usage` | Show usage dashboard | |
38 | 34 | | `agent-limit version` | Show version | |
39 | 35 | | `agent-limit help` | Show help message | |
40 | 36 |
|
41 | | -## Dashboard Controls |
| 37 | +### Dashboard Controls |
42 | 38 |
|
43 | 39 | | Key | Action | |
44 | 40 | |-----|--------| |
45 | 41 | | `q` | Quit | |
46 | 42 | | `r` | Refresh | |
47 | 43 |
|
48 | | -## Features |
49 | | - |
50 | | -- Real-time usage tracking for Claude Code and Codex |
51 | | -- Trajectory markers showing if you're ahead or behind your usage pace |
52 | | -- Auto-refresh every 60 seconds |
53 | | -- Color-coded usage indicators |
54 | | - |
55 | 44 | ## Supported Providers |
56 | 45 |
|
57 | 46 | | Provider | Status | Data Source | |
58 | 47 | |----------|--------|-------------| |
59 | 48 | | Claude Code | Full support | macOS Keychain + Anthropic API | |
60 | 49 | | Codex | Full support | `~/.codex/auth.json` + OpenAI API | |
61 | 50 |
|
| 51 | +## How It Works |
| 52 | + |
| 53 | +agent-limit reads credentials from standard locations: |
| 54 | + |
| 55 | +- **Claude Code**: macOS Keychain (`Claude Code-credentials`) |
| 56 | +- **Codex**: `~/.codex/auth.json` |
| 57 | + |
| 58 | +It then fetches usage data from each provider's API and displays it in a unified dashboard. |
| 59 | + |
| 60 | +## Installation Options |
| 61 | + |
| 62 | +### Via npm |
| 63 | + |
| 64 | +```bash |
| 65 | +npm install -g agent-limit |
| 66 | +``` |
| 67 | + |
| 68 | +### Standalone Binary (no dependencies) |
| 69 | + |
| 70 | +Download from [GitHub Releases](https://github.com/AgentWorkforce/limit/releases): |
| 71 | + |
| 72 | +```bash |
| 73 | +# Apple Silicon |
| 74 | +curl -L https://github.com/AgentWorkforce/limit/releases/latest/download/agent-limit-darwin-arm64 -o /usr/local/bin/agent-limit |
| 75 | +chmod +x /usr/local/bin/agent-limit |
| 76 | + |
| 77 | +# Intel Mac |
| 78 | +curl -L https://github.com/AgentWorkforce/limit/releases/latest/download/agent-limit-darwin-x64 -o /usr/local/bin/agent-limit |
| 79 | +chmod +x /usr/local/bin/agent-limit |
| 80 | +``` |
| 81 | + |
| 82 | +## Requirements |
| 83 | + |
| 84 | +- macOS (uses Keychain for credential storage) |
| 85 | +- Active CLI authentication for providers you want to monitor |
| 86 | + |
62 | 87 | ## Development |
63 | 88 |
|
64 | 89 | ```bash |
@@ -96,32 +121,6 @@ bun run build:x64 # Intel |
96 | 121 |
|
97 | 122 | Binaries are output to `dist/`. |
98 | 123 |
|
99 | | -## How It Works |
100 | | - |
101 | | -agent-limit reads credentials from standard locations: |
102 | | - |
103 | | -- **Claude Code**: macOS Keychain (`Claude Code-credentials`) |
104 | | -- **Codex**: `~/.codex/auth.json` |
105 | | - |
106 | | -It then fetches usage data from each provider's API and displays it in a unified dashboard. |
107 | | - |
108 | | -### Trajectory Indicator |
109 | | - |
110 | | -Each progress bar shows a `|` marker indicating where your usage "should be" based on time elapsed in the reset period: |
111 | | - |
112 | | -``` |
113 | | -[███████░░░░|░░░░░░░░░] 30% ↓12% |
114 | | - ^ you should be at 42%, but you're at 30% (12% under pace) |
115 | | -``` |
116 | | - |
117 | | -- `↓X%` (green) = under pace, you have headroom |
118 | | -- `↑X%` (red) = over pace, might hit limits early |
119 | | - |
120 | | -## Requirements |
121 | | - |
122 | | -- macOS (uses Keychain for credential storage) |
123 | | -- Active CLI authentication for providers you want to monitor |
124 | | - |
125 | 124 | ## License |
126 | 125 |
|
127 | 126 | MIT |
0 commit comments