Skip to content

docs(config): add comprehensive configuration documentation#162

Merged
AnnatarHe merged 2 commits intomainfrom
docs/config-documentation
Dec 25, 2025
Merged

docs(config): add comprehensive configuration documentation#162
AnnatarHe merged 2 commits intomainfrom
docs/config-documentation

Conversation

@AnnatarHe
Copy link
Copy Markdown
Contributor

Summary

  • Add docs/CONFIG.md with detailed guide for all configuration options
  • Cover core settings, privacy & security, command filtering, AI features
  • Include Claude Code integration documentation (CCOtel, CCUsage, CodeTracking)
  • Add complete example config file and FAQ section
  • Update README.md to link to the full configuration guide

Test plan

  • Verify all config options documented match actual codebase
  • Check markdown renders correctly on GitHub
  • Confirm links work properly

🤖 Generated with Claude Code

- Create docs/CONFIG.md with detailed guide for all config options
- Cover core settings, privacy, command filtering, AI features
- Include Claude Code integration (CCOtel, CCUsage, CodeTracking)
- Add complete example config and FAQ section
- Update README.md to link to the full configuration guide

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@gemini-code-assist
Copy link
Copy Markdown
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 the user experience by introducing a detailed and comprehensive configuration guide for the ShellTime CLI. The new documentation aims to clarify all available settings, making it easier for users to customize their environment, manage privacy, and leverage advanced features like AI integration and Claude Code metrics.

Highlights

  • New Configuration Guide: A new file, docs/CONFIG.md, has been added which provides a comprehensive guide to all ShellTime CLI configuration options.
  • Detailed Configuration Sections: The new documentation covers core settings, privacy and security features, command filtering, AI features, and Claude Code integration.
  • Example and FAQ: The guide includes a complete example configuration file and a frequently asked questions (FAQ) section to assist users.
  • README Update: The README.md file has been updated to include a direct link to the newly added full configuration guide.
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.

Copy link
Copy Markdown
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 introduces a comprehensive configuration guide, which is a fantastic addition for users. The documentation is well-structured and covers a wide range of options. I've provided a few suggestions to improve clarity and correctness, mainly concerning platform-specific details and a discrepancy in a default port number. Once these points are addressed, this will be an excellent piece of documentation.

Comment thread docs/CONFIG.md Outdated
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `ccotel.enabled` | boolean | `false` | Enable OTEL collection |
| `ccotel.grpcPort` | integer | `4317` | gRPC server port |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

high

There is a critical discrepancy in the default value for ccotel.grpcPort. The documentation (here and in the example on line 261) states the default is 4317. However, the code in model/config.go:183 defaults to 54027 if the value is not set. This will cause connection failures for users who rely on the documentation. Please align the documentation and the code to use a single, consistent default port.

Comment thread docs/CONFIG.md

## Quick Start

Create a configuration file at `~/.shelltime/config.toml`:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The documentation consistently uses ~ to refer to the user's home directory (e.g., ~/.shelltime/config.toml). While standard on Unix-like systems, this can be ambiguous for Windows users, where the home directory is typically %USERPROFILE%. Since the tool appears to support Windows, please consider adding a note early in the document to clarify this. For example:

Note on paths: The ~ character represents your home directory ($HOME on Linux/macOS, %USERPROFILE% on Windows).

Comment thread docs/CONFIG.md

| Option | Type | Default |
|--------|------|---------|
| `socketPath` | string | `/tmp/shelltime.sock` |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The default socketPath is documented as /tmp/shelltime.sock, which is a Unix-specific path and invalid on Windows. Please clarify the default path for Windows or state that this option is specific to Unix-like operating systems to avoid confusion for Windows users.

Comment thread docs/CONFIG.md
Comment on lines +326 to +331
**Files cleaned:**
- `~/.shelltime/log.log`
- `~/.shelltime/heartbeat.log`
- `~/.shelltime/sync-pending.txt`
- `~/.shelltime/logs/shelltime-daemon.log` (macOS)
- `~/.shelltime/logs/shelltime-daemon.err` (macOS)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

This section helpfully notes that daemon log cleanup applies to macOS. For completeness, it would be beneficial to also mention the behavior on Linux. According to code comments in model/log_cleanup.go, on Linux the daemon logs to the systemd journal, which is managed separately and not cleaned by this mechanism. Adding this detail will prevent confusion for Linux users.

@codecov
Copy link
Copy Markdown

codecov Bot commented Dec 25, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

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

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.

The default grpcPort is 54027, not 4317, as defined in model/config.go

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@AnnatarHe AnnatarHe merged commit e9f1fb7 into main Dec 25, 2025
3 checks passed
@AnnatarHe AnnatarHe deleted the docs/config-documentation branch December 25, 2025 14:56
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