Skip to content

Comments

docs(cc-statusline): update docs for clickable links and new fields#232

Merged
AnnatarHe merged 1 commit intomainfrom
docs/update-cc-statusline-docs
Feb 13, 2026
Merged

docs(cc-statusline): update docs for clickable links and new fields#232
AnnatarHe merged 1 commit intomainfrom
docs/update-cc-statusline-docs

Conversation

@AnnatarHe
Copy link
Contributor

@AnnatarHe AnnatarHe commented Feb 13, 2026

Summary

  • Update docs/CC_STATUSLINE.md and README.md to match the current cc statusline implementation
  • Add clickable links section documenting OSC 8 terminal hyperlinks for Session, Daily, Quota, and Time sections
  • Fix JSON input example (working_directorycwd, add session_id, hook_event_name, version, workspace)
  • Update output format table with accurate colors (Daily: Yellow/Gray, Time: Magenta/Gray) and link targets
  • Add platform note about Linux omitting the quota section entirely
  • Add session-project mapping and daemon request timeout (50ms) to performance section
  • Update README example output and sections table with all 7 sections

Test plan

  • Review updated docs against commands/cc_statusline.go for accuracy
  • Verify JSON input fields match model/cc_statusline_types.go
  • Confirm all link URL patterns match the code

🤖 Generated with Claude Code


Open with Devin

…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>
@chatgpt-codex-connector
Copy link

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @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 cc statusline feature. The changes ensure that the README.md and docs/CC_STATUSLINE.md files accurately reflect the current implementation, including new features like clickable terminal links and updated output formats. It also clarifies platform-specific behaviors and provides a more precise JSON input example, improving user understanding and troubleshooting capabilities for the status line.

Highlights

  • Documentation Updates: Updated documentation for cc statusline in README.md and docs/CC_STATUSLINE.md to reflect current features and implementation details.
  • Clickable Links: Introduced documentation for clickable links in the status line using OSC 8 terminal hyperlinks for Session, Daily, Quota, and Time sections.
  • JSON Input Example Correction: Corrected the JSON input example, replacing working_directory with cwd and adding session_id, hook_event_name, version, and workspace fields for accuracy.
  • Output Format and Colors: Revised the output format table to include accurate color descriptions (Daily: Yellow/Gray, Time: Magenta/Gray) and link targets for various status line sections.
  • Platform-Specific Quota Note: Added a specific note detailing that the quota section is omitted on Linux platforms, while always shown on macOS.
  • Performance Section Enhancements: Included details on session-project mapping and a 50ms daemon request timeout in the performance section.
  • README Example Expansion: Updated the README.md example output and sections table to reflect all seven status line sections.
Changelog
  • README.md
    • Updated the example status line output to reflect the full seven sections, including Git Branch, Quota, and Time.
    • Expanded the status line sections table to include Git Branch, Quota, and Time, and added descriptions for clickable links for Session, Daily, Quota, and Time.
  • docs/CC_STATUSLINE.md
    • Clarified that Anthropic API quota utilization is specific to macOS.
    • Revised the output format table to include a 'Clickable Link' column and updated color descriptions for Daily and Time sections.
    • Added a dedicated 'Clickable Links' section explaining the OSC 8 protocol and providing specific link targets for Session, Daily, Quota, and Time.
    • Included a 'Platform Note' specifying that the quota section is omitted on Linux.
    • Updated the JSON input example to use cwd and introduced hook_event_name, session_id, version, and workspace fields.
    • Updated the 'Quota shows -' troubleshooting section to mention Linux omission.
    • Added 'Daemon request timeout' and 'Session mapping' to the performance section.
    • Introduced a new troubleshooting section 'Links not clickable' explaining OSC 8 protocol requirements.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@codecov
Copy link

codecov bot commented Feb 13, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag Coverage Δ
unittests 37.56% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@AnnatarHe AnnatarHe merged commit 71a3574 into main Feb 13, 2026
3 checks passed
@AnnatarHe AnnatarHe deleted the docs/update-cc-statusline-docs branch February 13, 2026 13:45
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 `🚦 -`).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
- **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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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'.

Suggested change
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)

Copy link

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

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.

1 participant