docs(readme): Add Claude Code Plugins documentation#894
Conversation
Add comprehensive documentation for Claude Code plugins: - Overview of repomix-mcp and repomix-commands plugins - Installation instructions for Claude Code - Example usage with natural language commands - Benefits and features of using plugins - Cross-reference from MCP Server Integration section This provides users with clear guidance on how to use Repomix with Claude Code through the official plugin system.
Update installation section to use correct Claude Code plugin commands: - Use /plugin marketplace add for adding marketplace - Use /plugin install with @marketplace syntax - Add interactive /plugin command option Remove outdated file path-based installation instructions.
Summary of ChangesHello @yamadashy, 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 introduces comprehensive documentation for the official Claude Code plugins, which were previously added in #893. The new documentation aims to simplify the discovery and adoption of these Repomix integrations for users by detailing their functionality, installation process, and benefits within 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
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the official Repomix Claude Code plugins, making it easier for users to discover and use the plugins introduced in #893.
- Adds a new "Claude Code Plugins" section with installation and usage instructions
- Documents two available plugins: repomix-mcp and repomix-commands
- Provides practical examples and highlights key benefits of the plugin integration
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughREADME.md updated to add a “Claude Code Plugins” section documenting official Repomix plugins (repomix-mcp and repomix-commands), including features, available commands, installation/interactive installer, benefits, examples, MCP tools list, and links. A cross-reference note was added pointing readers to this new section. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #894 +/- ##
=======================================
Coverage 74.66% 74.66%
=======================================
Files 109 109
Lines 7653 7653
Branches 1433 1433
=======================================
Hits 5714 5714
Misses 1939 1939 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
PR Review: Claude Code Plugins DocumentationGreat work on documenting the new Claude Code plugins! This is a well-structured addition that will help users discover and adopt the plugin integration. Here's my feedback: ✅ Strengths
📝 Suggestions for Improvement1. Minor typo in pack-remote exampleIn line 956 of README.md, there's an inconsistency in the example: The command uses
This would make the example more coherent and less confusing for new users. 2. Consider adding plugin dependency noteThe "requires": ["repomix-mcp"]While the installation instructions show both plugins being installed, it might be helpful to explicitly mention this dependency relationship. For example: **Note**: The `repomix-commands` plugin requires `repomix-mcp` to be installed first.This would help users understand the plugin architecture better. 3. Optional: Consider installation order recommendationGiven the dependency relationship, the installation order might matter. Consider reordering the installation commands to install the foundation plugin first: # Install MCP server plugin (foundation)
/plugin install repomix-mcp@repomix
# Install commands plugin
/plugin install repomix-commands@repomix🎯 AssessmentCode Quality: ✅ N/A (Documentation only) VerdictThis is a solid documentation PR that effectively introduces the Claude Code plugins to users. The only substantive issue is the typo/inconsistency in the pack-remote example. The other suggestions are minor enhancements that could improve clarity. Recommendation: ✅ Approve with minor revision to fix the example inconsistency. |
![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 adds valuable documentation for the new Claude Code plugins. The new section in the README is well-structured and covers the available plugins, installation, and benefits clearly. I've left a couple of suggestions to improve the clarity and correctness of the usage examples to avoid potential user confusion. Overall, this is a great addition to the documentation!
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
README.md (1)
956-956: Fix inconsistency: repo name vs. description.The command targets yamadashy/repomix, but the text says “react repository.” Make them consistent.
-User: "Pack only TypeScript files from the react repository" +User: "Pack only TypeScript files from the repomix repository"
🧹 Nitpick comments (1)
README.md (1)
993-994: Make the docs path clickable.Link the directory for easier navigation.
-For more details, see the plugin documentation in the `.claude/plugins/` directory. +For more details, see the plugin documentation in the [`.claude/plugins/`](.claude/plugins/) directory.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
951-951: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
- GitHub Check: Build and run (windows-latest, 22.x)
- GitHub Check: Build and run with Bun (windows-latest, latest)
- GitHub Check: Build and run (windows-latest, 20.x)
- GitHub Check: Test (windows-latest, 24.x)
- GitHub Check: Test with Bun (macos-latest, latest)
- GitHub Check: Test with Bun (windows-latest, latest)
🔇 Additional comments (1)
README.md (1)
901-902: Clear cross-reference. LGTM.Anchor resolves to the new section correctly.
Update command examples to use the actual format with plugin prefix: - /pack-local -> /repomix-commands:pack-local - /pack-remote -> /repomix-commands:pack-remote This matches the actual command format shown in Claude Code.
Deploying repomix with
|
| Latest commit: |
7d8565e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d833b262.repomix.pages.dev |
| Branch Preview URL: | https://docs-plugin.repomix.pages.dev |
Pull Request ReviewThis PR adds comprehensive documentation for the Claude Code plugins introduced in #893. Overall, this is excellent documentation work that makes the plugins easily discoverable and accessible to users. ✅ ✅ Strengths
Detailed FeedbackDocumentation QualityAccuracy ✅
Completeness ✅
Usability ✅
Content StructureAvailable Plugins Section
Installation Section
Benefits Section
Commit HistoryThe three commits show good iterative improvement:
This demonstrates careful attention to accuracy and willingness to correct mistakes. Minor Observations
RecommendationsOptional Improvements (Not Blocking)
Security & Best Practices ✅
ConclusionThis is excellent documentation work that significantly improves the discoverability and usability of the Claude Code plugins. The documentation is accurate, well-structured, and provides clear value to users. Status: Approved ✅ The minor observations noted above are optional improvements and should not block merging this PR. |
Move the Claude Code Plugins section after the Available MCP Tools section for better documentation flow. This creates a more logical structure: 1. MCP Server Integration (overview) 2. Available MCP Tools (technical details) 3. Claude Code Plugins (user-friendly integration) 4. Configuration This organization helps users understand the MCP foundation before learning about the convenient Claude Code plugin wrappers.
PR Review: Claude Code Plugins DocumentationThank you for adding comprehensive documentation for the Claude Code plugins! This is a well-structured addition that will help users discover and adopt the plugin integration. Here's my detailed feedback: ✅ Strengths
📝 Suggestions for Improvement1. Command Syntax InconsistencyThe slash command examples in the "Usage Examples" section show incorrect syntax: Based on the plugin files (
Recommendation: Update the examples to use the correct command names: See: README.md:1022-1028 2. Minor Typo in Example DescriptionIn line 1028, the example says "Pack only TypeScript files from the react repository" but the command references Recommendation: Either change the description to match the repository or update the command to use a React-related repository: See: README.md:1028 3. Consider Adding Feature ComparisonSince both plugins exist, it might help users understand when to use slash commands vs. when Claude will automatically use MCP tools. Consider adding a brief note like: **When to use which:**
- **MCP Tools**: Claude automatically uses these when analyzing your requests
- **Slash Commands**: Use these for explicit, quick operations with natural language flexibilityThis would help clarify the relationship between the two plugins. 4. Installation Order ConsiderationThe installation section shows installing Recommendation: Reorder the installation commands to show MCP first: # Install MCP server plugin (foundation)
/plugin install repomix-mcp@repomix
# Install commands plugin
/plugin install repomix-commands@repomixAnd add a note explaining the dependency relationship. See: README.md:1042-1047 🎯 Additional Observations
🔍 No Issues Found With
✨ Overall AssessmentThis is a high-quality documentation addition that will significantly improve plugin discoverability. The main issues are minor syntax corrections that will improve accuracy and user experience. Once the command syntax is corrected, this will be ready to merge. Recommendation: Approve after addressing the command syntax inconsistency in the Usage Examples section. |
- Update example repository name to be consistent - Clarify plugin installation order and relationship - Add 'text' language tag to code blocks - Explain recommended plugin installation process Addresses review comments from Gemini Code Assist and Copilot
Code Review: Claude Code Plugins DocumentationGreat work on documenting the new Claude Code plugins! This PR adds valuable documentation that will help users discover and adopt the plugin integration. Here's my feedback: ✅ Strengths
📝 Suggestions for Improvement1. Minor Inconsistency in Example Repository Reference (Line 1028)Issue: The example shows Current: Suggested fix: Or alternatively: This would make the example more consistent and clear. 2. Consider Simplifying the Code Fence Language (Line 1053)Issue: Using Current: **Alternatively, use the interactive plugin installer:**
\`\`\`bash
/plugin
\`\`\`Suggested fix: **Alternatively, use the interactive plugin installer:**
\`\`\`text
/plugin
\`\`\`This matches the format used for other command examples in the section. 3. Plugin Dependency Information Could Be More ProminentObservation: The note about Current approach is actually fine, but you might consider making this dependency relationship even more visible, perhaps with a callout box or emphasized note. This is optional and not a blocker. 4. Consider Adding Troubleshooting or FAQ SectionEnhancement: While not required for this PR, a future enhancement could include:
This could be a follow-up PR or added to the plugin documentation in 🔍 Quality Checks
🎯 ConclusionThis is a solid documentation PR that achieves its goal of making the Claude Code plugins discoverable. The suggestions above are minor improvements - the only one I'd strongly recommend addressing is the inconsistency in example #1 (line 1028). The others are optional enhancements. Recommendation: Approve with minor revisions suggested. Great job! 🚀 |
- Create comprehensive documentation page for Claude Code plugins - Add navigation entry in Advanced section - Include installation, usage, and troubleshooting guides - Document both repomix-mcp and repomix-commands plugins This provides English documentation for the official Claude Code plugins, covering installation, usage examples, benefits, and troubleshooting.
Review SummaryThis documentation PR effectively introduces the Claude Code plugins feature to users. The documentation is well-structured, comprehensive, and follows good practices. ✅ Strengths
📝 Suggestions for Improvement1. Command Format Discrepancy (Minor)The docs show Recommendation: Verify correct command format. Update docs to show actual commands users type. Files: README.md:1022-1025, claude-code-plugins.md:21-22 2. Plugin Dependency ClarificationDocs say plugins can be installed independently, but Current (README.md:1052): "While you can install them independently, using both provides the most comprehensive experience." Suggested: "The repomix-commands plugin requires repomix-mcp as a dependency. Install repomix-mcp first, then add repomix-commands for convenient slash commands." Files: README.md:1052, claude-code-plugins.md:48 3. Example ConsistencyREADME.md:1034 mentions "yamadashy/repomix" twice (in command and description). Consider using different repos for clarity: 4. Missing Troubleshooting ScenarioAdd troubleshooting for execution issues:
5. Documentation-Only PR ChecklistConsider running 🎯 Overall AssessmentQuality: ⭐⭐⭐⭐ (4/5)
Recommendation: Approve with minor suggested changes Great work! 🎉 The Claude Code plugins will significantly improve developer experience. |
Remove unnecessary sections: - Benefits (redundant with features) - Advanced Features (too detailed) - Troubleshooting (not essential for docs) Keep only essential information: overview, installation, usage examples, and related resources.
- Create comprehensive Japanese documentation page - Add navigation entry in Advanced section - Include installation, usage examples, and resources - Translate all content from English version
PR ReviewGreat work on adding comprehensive documentation for the Claude Code plugins! This PR effectively documents the new plugin functionality introduced in #893. The documentation is clear, well-structured, and provides practical examples that will help users get started quickly. Strengths
Minor Suggestions
Verification Checklist
Final VerdictThis PR is ready to merge with only minor documentation clarifications suggested above. The core documentation is accurate, helpful, and well-written. The suggestions are refinements rather than blockers. Recommendation: Approve with minor suggestions Review generated by Claude Code |
PR Review: Claude Code Plugins DocumentationThank you for this comprehensive documentation PR! This is an excellent addition that makes the Claude Code plugins much more accessible to users. Strengths
Minor Suggestions (Optional)
Documentation Quality Assessment
Security and Performance
Overall AssessmentThis is a high-quality documentation PR that significantly enhances the discoverability and usability of the Claude Code plugins introduced in #893. The documentation is clear, comprehensive, and follows all project guidelines. Recommendation: Approve The minor suggestions above are optional improvements and should not block merging. This PR is ready to merge as-is and provides excellent value to users. |
Add comprehensive documentation and navigation for Claude Code plugins in all supported languages: - Chinese (Simplified & Traditional) - Korean - Vietnamese - Hindi - Indonesian - Portuguese (Brazil) - Spanish - French - German Each language includes: - Plugin overview and features - Installation instructions - Usage examples with natural language commands - Related resources and links
PR Review: Add Claude Code Plugins DocumentationSummaryThis is a documentation-only PR that adds comprehensive documentation for the Claude Code plugins introduced in #893. The changes are well-structured and provide clear guidance for users. ✅ Strengths
📝 Minor ObservationsDetails1. Inconsistency in README Example (Line 931)In the README's "Example usage" section: The repository mentioned is 2. Minor Wording SuggestionIn the README (line 948), the Note section reads:
Consider simplifying to:
3. Code Block FormattingIn the README (line 952), you have: /pluginThis should be: to match the other plugin commands, since this is not a bash command. 4. Documentation ReferenceThe README mentions (line 965):
It might be helpful to also link to the dedicated documentation page:
🔍 Quality Checks
RecommendationApprove with minor fixes suggested above. The documentation is comprehensive and user-friendly. The issues noted are minor and don't block merging. Great work on making the Claude Code plugins discoverable and easy to use! 🎉 |
Add a note in the MCP Server documentation (all languages) that users can alternatively use the official Repomix plugins for a more convenient experience with natural language commands and easier setup. This provides a cross-reference between the MCP server configuration and the plugin-based approach.
Pull Request ReviewThis PR adds comprehensive documentation for the Claude Code plugins introduced in #893. Overall, this is excellent documentation work with consistent structure across all 12 language translations. ✅ Strengths
📋 Documentation QualityDetailsThe documentation effectively covers:
The cross-referencing between MCP Server and Claude Code Plugins sections helps users understand both options are available. 🎯 Suggestions for ImprovementMinor suggestions (non-blocking)
🔍 Verification Checklist
✨ Overall AssessmentThis is high-quality documentation work that makes the new Claude Code plugins discoverable and easy to use. The comprehensive multi-language support and clear structure will help users adopt this feature quickly. Recommendation: APPROVE ✅ The minor suggestions above are optional improvements that don't block merging. |
Add comprehensive documentation for the official Claude Code plugins introduced in #893.
This PR adds a new section to the README explaining how to install and use the Repomix plugins for Claude Code, making it easier for users to discover and adopt this integration.
Summary
Added a new "Claude Code Plugins" section in the README that documents:
1. Available Plugins
2. Installation Instructions
Clear step-by-step instructions using the Claude Code plugin commands:
3. Usage Examples
Practical examples showing how to use the slash commands:
4. Benefits
Highlighted key advantages:
npx repomix@latest)Related
Checklist
npm run test(not applicable)npm run lint(not applicable)