docs(cc-statusline): update docs for clickable links and new fields#232
docs(cc-statusline): update docs for clickable links and new fields#232
Conversation
…g, and new fields Update CC_STATUSLINE.md and README.md to reflect the current implementation: - Add clickable links section documenting OSC 8 terminal hyperlinks - Fix JSON input example: working_directory → cwd, add session_id, hook_event_name, version, workspace fields - Update output format table with accurate colors and link targets - Add platform note about Linux omitting quota section entirely - Add session-project mapping and daemon timeout to performance section - Update README example output and sections table with all 7 sections Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Summary of ChangesHello @AnnatarHe, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances and corrects the documentation for the Highlights
Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Code Review
This pull request provides a comprehensive update to the documentation for the cc statusline command, aligning it with the latest implementation. The changes are well-structured and significantly improve clarity for users, especially regarding clickable links, the JSON input structure, and platform-specific behavior. I've identified a minor inaccuracy in the documentation regarding platform support for the quota feature and suggested corrections to ensure it's clear for users on all operating systems.
|
|
||
| ### Platform Note | ||
|
|
||
| On **Linux**, the quota section (`🚦`) is omitted entirely from the output — the statusline skips from Daily Cost to Time. On **macOS**, it is always shown (either with data or as `🚦 -`). |
There was a problem hiding this comment.
The documentation states the quota section is omitted on Linux. However, the implementation checks for darwin (macOS) and omits the section for all other operating systems, including Windows. Generalizing this statement would make it more accurate for all users.
| On **Linux**, the quota section (`🚦`) is omitted entirely from the output — the statusline skips from Daily Cost to Time. On **macOS**, it is always shown (either with data or as `🚦 -`). | |
| On **platforms other than macOS**, the quota section (`🚦`) is omitted entirely from the output — the statusline skips from Daily Cost to Time. On **macOS**, it is always shown (either with data or as `🚦 -`). |
| Requires **macOS** and the ShellTime daemon running. The daemon reads Claude Code's OAuth token from the macOS Keychain (service name: `Claude Code-credentials`) and queries the Anthropic usage API. | ||
|
|
||
| - **macOS only** - Keychain access is required to retrieve the OAuth token | ||
| - **macOS only** - Keychain access is required to retrieve the OAuth token; on Linux the quota section is omitted entirely |
There was a problem hiding this comment.
For accuracy and to avoid confusion for users on other operating systems like Windows, this should mention that the quota section is omitted on all non-macOS platforms, not just Linux.
| - **macOS only** - Keychain access is required to retrieve the OAuth token; on Linux the quota section is omitted entirely | |
| - **macOS only** - Keychain access is required to retrieve the OAuth token; on other platforms the quota section is omitted entirely |
| ### Quota shows `-` | ||
|
|
||
| 1. Ensure you're on **macOS** - quota display is only available on macOS | ||
| 1. Ensure you're on **macOS** - quota display is only available on macOS (omitted entirely on Linux) |
There was a problem hiding this comment.
To make this troubleshooting step accurate for users on any non-macOS system (like Windows), it's better to generalize this from being specific to 'Linux'.
| 1. Ensure you're on **macOS** - quota display is only available on macOS (omitted entirely on Linux) | |
| 1. Ensure you're on **macOS** - quota display is only available on macOS (it is omitted on other platforms) |
Summary
docs/CC_STATUSLINE.mdandREADME.mdto match the currentcc statuslineimplementationworking_directory→cwd, addsession_id,hook_event_name,version,workspace)Test plan
commands/cc_statusline.gofor accuracymodel/cc_statusline_types.go🤖 Generated with Claude Code