Skip to content

README.md

Latest commit

 

History

History
95 lines (63 loc) · 2.23 KB

README.md

File metadata and controls

95 lines (63 loc) · 2.23 KB

TokenMeter

English | 中文

License: MIT Platform: macOS Tauri 2 React 19

A macOS menu bar app for real-time API usage tracking and cost monitoring.

Inspired by the xbar plugin claude_tokens.15m.py, rebuilt as a standalone native app with Tauri 2 + React.

TokenMeter Screenshot

Features

  • Real-time API usage display in menu bar
  • Dashboard with detailed charts and statistics
  • Support for ccusage and custom API providers
  • Configurable refresh interval, display format, and budget alerts
  • Launch at login
  • Multi-language support (English / Chinese)

Quick Start

Prerequisites

  • Node.js 18+
  • Rust 1.75+
  • macOS 10.15+
  • ccusage (optional, for Claude API usage tracking)

Installation

npm install

Development

npm run tauri dev

Build

npm run tauri build

Build artifacts are located in src-tauri/target/release/bundle/.

Configuration

Config files are stored in ~/.tokenmeter/:

Path Description
config.json App settings (refresh interval, menu bar format, budget, language)
providers/*.json Custom API provider configurations

Tech Stack

  • Backend: Tauri 2 + Rust
  • Frontend: React 19 + TypeScript + Vite
  • UI: TailwindCSS v4 + shadcn/ui
  • Data: Recharts + TanStack Query
  • i18n: i18next + react-i18next

Architecture

For detailed architecture diagrams and data flow documentation, see docs/ARCHITECTURE.md.

Development

See AGENTS.md for detailed development commands and code conventions.

Quality Checks

# Frontend lint
npm run lint

# Rust checks (run in src-tauri/)
cargo fmt --check && cargo clippy && cargo test

Contributing

Contributions are welcome! Please read AGENTS.md for development guidelines and quality gates before submitting PRs.

License

MIT