docs(readme): add dedicated Claude Code setup section#2266
Open
ahsanmunyr wants to merge 2 commits into
Open
Conversation
Add a step-by-step Claude Code Setup section under Installation covering hook install (rtk init -g), restart, and verification, plus common init variants and the Bash-only hook scope note. Claude Code is RTK's flagship integration but previously only appeared inline in Quick Start. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Rework the Claude Code Setup section into numbered steps: global init (showing the interactive 'Patch existing ~/.claude/settings.json? [y/N]' prompt and the y answer), restart, and verify by asking Claude to run a command plus checking 'rtk gain' for live savings. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a dedicated Claude Code Setup section to the README, placed under Installation (right after Verify Installation).
Why
Claude Code is RTK's flagship integration, but the README previously only mentioned it inline in Quick Start (
rtk init -g) and in the Supported AI Tools table. There was no single, step-by-step "here's how to wire RTK into Claude Code" section, which is the first thing most users want after installing the binary.Changes
## Claude Code Setupsection covering the three-step flow: install hook (rtk init -g), restart, verify (rtk init --show)rtk initvariants (project-only,--hook-only,--auto-patch,--uninstall)Read/Grep/Globbypass itDocs-only change; no code touched.
🤖 Generated with Claude Code