docs(config): add comprehensive configuration documentation#162
docs(config): add comprehensive configuration documentation#162
Conversation
- 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>
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 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
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
|
There was a problem hiding this comment.
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.
| | Option | Type | Default | Description | | ||
| |--------|------|---------|-------------| | ||
| | `ccotel.enabled` | boolean | `false` | Enable OTEL collection | | ||
| | `ccotel.grpcPort` | integer | `4317` | gRPC server port | |
There was a problem hiding this comment.
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.
|
|
||
| ## Quick Start | ||
|
|
||
| Create a configuration file at `~/.shelltime/config.toml`: |
There was a problem hiding this comment.
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 ($HOMEon Linux/macOS,%USERPROFILE%on Windows).
|
|
||
| | Option | Type | Default | | ||
| |--------|------|---------| | ||
| | `socketPath` | string | `/tmp/shelltime.sock` | |
There was a problem hiding this comment.
| **Files cleaned:** | ||
| - `~/.shelltime/log.log` | ||
| - `~/.shelltime/heartbeat.log` | ||
| - `~/.shelltime/sync-pending.txt` | ||
| - `~/.shelltime/logs/shelltime-daemon.log` (macOS) | ||
| - `~/.shelltime/logs/shelltime-daemon.err` (macOS) |
There was a problem hiding this comment.
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 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:
|
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>
Summary
docs/CONFIG.mdwith detailed guide for all configuration optionsTest plan
🤖 Generated with Claude Code