Skip to content

docs: add native macOS companion app to Companion Apps section#222

Open
HAOGRE wants to merge 1 commit into
Maciek-roboblog:mainfrom
HAOGRE:companion-app-macos
Open

docs: add native macOS companion app to Companion Apps section#222
HAOGRE wants to merge 1 commit into
Maciek-roboblog:mainfrom
HAOGRE:companion-app-macos

Conversation

@HAOGRE

@HAOGRE HAOGRE commented Jun 29, 2026

Copy link
Copy Markdown

Preview

Status Bar

Active (Token Rates) Idle (Accumulated Cost)

Dark Mode

Day Week Month

Light Mode

Day Week Month

Summary

Following up on the feedback from #215 — as suggested, I've built a separate companion repository that consumes the v4 state protocol instead of being merged into the core package.

This PR adds a small Companion Apps section to the README listing the macOS menu bar app.


What was built

Claude Token Monitor for macOS

A native Swift/SwiftUI menu bar app that:

  • Reads ~/.claude/projects/*.jsonl directly for token stats and cost tracking
  • Consumes the monitor's generated v4 state protocol at runtime to display the official 5-hour rate limit window with a progress bar and reset time
  • Zero external dependencies, Universal binary (Intel + Apple Silicon), macOS 14.0+
  • The v4 rate limit section appears automatically when this monitor is running; if not, the app works standalone

This strictly follows the companion-app architecture you outlined: the Python project owns the data/protocol layer, the macOS app is a pure consumer.


Change

Single addition to README.md: a 🛠️ Companion Apps section before Star History, with one table row linking to the macOS app.

Happy to adjust the wording, placement, or table format to fit your style.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added a new “Companion Apps” section to the README acknowledgments area.
    • Highlighted a community-built companion tool with a brief description and platform details.
    • Included a note inviting additional companion apps to be added in future updates.

@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

A new "Companion Apps" section is added to README.md listing one community-built tool (Claude Token Monitor, macOS menu bar app) in a table, along with a note inviting contributors to add more apps via PR.

Changes

README Companion Apps Section

Layer / File(s) Summary
Companion Apps entry
README.md
Adds a "Companion Apps" section with a single-row table for Claude Token Monitor and a contributor prompt.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A new little section hops into view,
A menu bar friend, on macOS it grew.
🐇 The README now lists a companion so fine,
Open a PR and add yours to the line!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the README/docs change adding a native macOS companion app to the Companion Apps section.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@kramersharp

Copy link
Copy Markdown

ClaimVerifier: blocking findings

The following file claims in commit messages / PR body were not actually modified on this branch:

  • claude-monitor/state/latest.json — Claim in pr_body references claude-monitor/state/latest.json but branch diff does not modify it

Please update the claim or add the missing changes.

@HAOGRE

HAOGRE commented Jul 9, 2026

Copy link
Copy Markdown
Author

@kramersharp Resolved the ClaimVerifier finding by removing the repository-looking runtime path from the PR body. The branch intentionally only modifies README.md; the v4 state file is consumed at runtime by the companion app and is not part of this PR diff.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants