docs(readme): fix installation instructions to match source of truth #14
Conversation
- Add Prerequisites section with actual CLI install command - Add `shelltime init` for proper initialization (auth, hooks, daemon) - Add shell reload instructions for zsh/fish/bash - Add both YAML and TOML config examples - Simplify Quick Start to reference Prerequisites - Update troubleshooting with init command hint 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 refines the installation and setup documentation in the 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
|
Pull Request Review: PR #14SummaryThis PR improves the installation documentation by adding a comprehensive Prerequisites section with CLI installation, initialization, and configuration steps. This addresses a significant gap in the user onboarding experience. ✅ Positives
📝 Suggestions & Observations1. Security ConsiderationThe installation command uses curl -sSL https://shelltime.xyz/i | bashRecommendation: Consider adding a note about what the script does or suggest users inspect it first: # Review the installation script first (optional)
curl -sSL https://shelltime.xyz/i | less
# Then install
curl -sSL https://shelltime.xyz/i | bash2. Shell Reload InstructionsThe shell reload commands are helpful, but users might not know which shell they're using. Suggestion: Add a hint for checking the current shell: # Check your current shell
echo $SHELL
# Then reload accordingly:
- **zsh**: `source ~/.zshrc`
- **fish**: `source ~/.config/fish/config.fish`
- **bash**: `source ~/.bashrc`3. Config File Location ClarityThe README mentions both Question: Does the CLI generate one format by default? Consider mentioning which format is created by 4. Prerequisites vs Requirements SectionNow that we have a Prerequisites section, the Requirements section feels slightly redundant. Consider:
5. Minor Formatting SuggestionIn the TOML example, consider adding a comment for consistency with the YAML section: # ~/.shelltime/config.toml
[codeTracking]
enabled = true🐛 Potential IssuesNone identified - The changes are documentation-only and don't introduce any code bugs. 🔧 Code Quality
📊 Test PlanThe test plan in the PR description is appropriate:
Additional suggestion: Consider verifying that the installation commands actually work on a fresh system (ideally tested on macOS, Linux, and WSL). 🎯 Overall AssessmentVerdict: ✅ Approve with minor suggestions This is a high-quality documentation improvement that will significantly help new users. The changes are well-structured and solve a real onboarding problem. The suggestions above are minor enhancements that could be addressed in this PR or future iterations. The most important consideration is the security note about piping to bash, which is worth addressing given that this is the first command new users will run. Great work on improving the user experience! 🚀 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly improves the installation and setup instructions in the README. The new 'Prerequisites' section is clear, and simplifying the 'Quick Start' makes the document much easier to follow. I've added a couple of suggestions to further enhance the clarity and security of the installation steps. Overall, great work on making the onboarding process smoother for new users.
| ```bash | ||
| curl -sSL https://shelltime.xyz/i | bash | ||
| ``` |
There was a problem hiding this comment.
Piping curl to bash is convenient, but it's a security risk because it executes remote code without inspection. It's a good practice to offer a safer alternative where the user downloads the script first, can optionally inspect it, and then executes it.
| ```bash | |
| curl -sSL https://shelltime.xyz/i | bash | |
| ``` | |
| curl -sSL https://shelltime.xyz/i -o install.sh | |
| # You can inspect install.sh before running it | |
| bash install.sh |
| curl -sSL https://shelltime.xyz/i | bash | ||
| ``` | ||
|
|
||
| After installation, reload your shell configuration: |
There was a problem hiding this comment.
Suggesting to 'reload your shell configuration' might be confusing for some users, and sourcing files like .bashrc doesn't always work for all shell setups (e.g., login shells using .bash_profile). A simpler and more reliable instruction is to open a new terminal. It's good to mention both options for completeness.
| After installation, reload your shell configuration: | |
| After installation, open a new terminal or reload your shell configuration: |
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
Summary
curl -sSL https://shelltime.xyz/i | bash)shelltime initfor proper initialization (auth, hooks, daemon)shelltime inithintTest plan
🤖 Generated with Claude Code