usage-board 0.0.0 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 lonewolfyx
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,75 @@
1
+ <div align="center">
2
+ <img src="https://cdn.jsdelivr.net/gh/lonewolfyx/usage-board@master/public/logo.svg" alt="usage-board logo" width="256" height="256">
3
+ <h1>usage-board</h1>
4
+ </div>
5
+ <div align="center">
6
+ <img src="https://cdn.jsdelivr.net/gh/lonewolfyx/usage-board@master/Snapshot.png" alt="usage-board">
7
+ </div>
8
+
9
+
10
+ An all-in-one dashboard to quickly analyze token usage from local json files
11
+
12
+ ## Quick Start
13
+
14
+ ```bash
15
+ npx usage-board@latest
16
+ ```
17
+
18
+ After starting, follow the terminal prompts to open the local page and view the usage dashboard.
19
+
20
+ ## Features
21
+
22
+ - Overview of core metrics: AI Coding token usage, costs, session counts
23
+ - Daily token consumption and cost trends by date
24
+ - Monthly statistics for model usage distribution and consumption changes
25
+ - Project-based analysis of token and cost distribution
26
+ - Session-level usage details including model, duration, input tokens, output tokens, cache tokens, and costs
27
+ - Codex usage data dashboard with multi-dimensional views (daily, weekly, monthly, by session)
28
+ - Token heatmap for quickly identifying high-frequency or high-consumption dates
29
+ - Cache hit and token efficiency metrics to help optimize usage costs
30
+ - Built with Nuxt, suitable for extending into team or personal AI usage analysis tools
31
+
32
+ ## Development
33
+
34
+ Install dependencies:
35
+
36
+ ```bash
37
+ pnpm install
38
+ ```
39
+
40
+ Start the local development server:
41
+
42
+ ```bash
43
+ pnpm dev
44
+ ```
45
+
46
+ Default access URL:
47
+
48
+ ```bash
49
+ http://localhost:3000
50
+ ```
51
+
52
+ Common development commands:
53
+
54
+ ```bash
55
+ # Type checking
56
+ pnpm typecheck
57
+
58
+ # Linting
59
+ pnpm lint
60
+
61
+ # Auto-fix code style
62
+ pnpm lint:fix
63
+
64
+ # Build for production
65
+ pnpm build
66
+
67
+ # Preview production build locally
68
+ pnpm preview
69
+ ```
70
+
71
+ ## License
72
+
73
+ This project is open-sourced under the MIT License.
74
+
75
+ This project is extended from [`ryoppippi/ccusage`](https://github.com/ryoppippi/ccusage). Thanks to the original project author and community contributors.
package/bin/cli.js ADDED
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env node
2
+
3
+ await import('../dist/index.mjs')