Skip to content

stevengonsalvez/qstatus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

50 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

QStatus Monitor ๐Ÿš€

Real-time monitoring for your Amazon Q Developer usage with native macOS menubar app and CLI dashboard.

QStatus Menubar QStatus CLI

โœจ Features

๐Ÿ“Š Real-time Monitoring

  • Token Usage: Track context window consumption across all sessions
  • Cost Tracking: Monitor spending by day, week, and month
  • Burn Rate: See your token consumption rate in real-time
  • Message Quota: Track your monthly message allowance (363/5000 shown above)

๐ŸŽฏ Dual Interface

  • macOS Menubar App: Always-visible usage indicator with detailed dropdown
  • CLI Dashboard: Full-featured terminal UI for power users

๐Ÿ”ฅ Smart Analytics

  • Session Tracking: Individual conversation monitoring with folder organization
  • Visual Indicators: Color-coded usage bars (green/yellow/red)
  • Top Sessions: Sort by tokens, usage percentage, or cost
  • Group by Folder: Organize sessions by project directory

๐Ÿ“ฆ Installation

Homebrew (Easiest)

# Add the tap
brew tap stevengonsalvez/qstatus

# Install CLI tool
brew install qstatus-cli

# Install Menubar app
brew install --cask qstatus-menu

Quick Install Script

# Download and run the installer
curl -sSL https://github.com/stevengonsalvez/qstatus/releases/latest/download/install.sh | bash

Install from Release

  1. Download the latest release from Releases
  2. Open QStatus.dmg
  3. Drag QStatus to your Applications folder
  4. Launch from Applications or Spotlight

Build from Source

# Clone the repository
git clone https://github.com/stevengonsalvez/qstatus.git
cd qstatus

# Install both apps (from qstatus-menu directory)
cd qstatus-menu && make install

# Or install individually
make install-cli      # CLI only
make install-menubar  # Menubar app only

๐Ÿ–ฅ๏ธ Usage

Menubar App

  1. Launch QStatus from Applications
  2. Click the menubar icon to see:
    • Overall stats: Sessions, tokens, costs
    • Recent sessions: Visual progress bars
    • Top sessions: Sortable by different metrics
    • Preferences: Customize settings

Features:

  • ๐ŸŸข Green = Safe usage (<50%)
  • ๐ŸŸก Yellow = Warning (50-90%)
  • ๐Ÿ”ด Red = Critical (>90%)
  • Click any session for detailed breakdown
  • Search sessions by ID or folder
  • Group toggle for folder-based view

CLI Dashboard

# Run the dashboard (interactive TUI by default)
qstatus

# With custom refresh rate
qstatus --refresh-rate 5

# Enable debug logging
qstatus --debug

Features:

  • Real-time updates every 2 seconds
  • Session list with usage indicators
  • System metrics and burn rate
  • Message quota tracking
  • Color-coded warnings

โš™๏ธ Configuration

Menubar Preferences

  • Context Window: Default 175,000 tokens (configurable)
  • Token Pricing: Default $0.0066/1K tokens (configurable)
  • Refresh Rate: Update interval in seconds
  • Compact Mode: Toggle detailed view elements

Database Location

Both apps read from Amazon Q's SQLite database:

~/Library/Application Support/amazon-q/data.sqlite3

๐Ÿ› ๏ธ Development

Requirements

  • macOS 11.0+
  • Rust (for CLI)
  • Swift 5.5+ (for menubar app)
  • Xcode Command Line Tools

Project Structure

qstatus/
โ”œโ”€โ”€ qstatus-cli/        # Rust CLI application
โ”‚   โ”œโ”€โ”€ src/
โ”‚   โ””โ”€โ”€ Cargo.toml
โ”œโ”€โ”€ qstatus-menu/    # Swift menubar application
โ”‚   โ”œโ”€โ”€ Sources/
โ”‚   โ”œโ”€โ”€ Package.swift
โ”‚   โ””โ”€โ”€ Makefile
โ”œโ”€โ”€ docs/
โ”‚   โ””โ”€โ”€ screenshots/     # Application screenshots
โ””โ”€โ”€ README.md

Building

# From qstatus-menu directory
cd qstatus-menu

# Build everything
make all

# Create release packages
make release

# Clean build artifacts
make clean

๐Ÿ“ License

MIT License - see LICENSE file for details.

๐Ÿค Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

๐Ÿ› Known Issues

  • Menubar app requires accessibility permissions on first launch
  • CLI requires /usr/local/bin in PATH
  • Database path may vary based on Amazon Q installation method

๐Ÿ“Š Screenshots

Menubar Dropdown View

Menubar App

Real-time monitoring with visual indicators, sortable sessions, and quota tracking

CLI Dashboard

CLI Dashboard

Terminal UI with session list, metrics, and burn rate tracking

๐Ÿ™ Acknowledgments

  • Built for the Amazon Q Developer community
  • Inspired by the need for better usage visibility
  • Thanks to all contributors and testers

๐Ÿ“ฎ Support

For issues, questions, or suggestions:


Made with โค๏ธ for developers using Amazon Q Developer

Latest Release License Stars