Skip to content

Commit 51d715f

Browse files
retsohuangclaude
andcommitted
📝 docs: add CLI tool documentation and plugin installation guidance
- Document plugin-kit CLI for manual installation with interactive wizard - Add keyboard controls reference table - Mark code-review-tools as manually installable (supports custom rules) - Clarify installation methods for each plugin (Manual/Marketplace/Either) - Update Available Plugins table with installation method indicators 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 7138e7b commit 51d715f

1 file changed

Lines changed: 42 additions & 5 deletions

File tree

README.md

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,41 @@ Users can add this marketplace to their Claude Code installation using one of th
2828
/plugin marketplace add https://github.com/retsohuang/retso-marketplace.git
2929
```
3030

31+
## CLI Tool (Manual Installation)
32+
33+
For manual plugin installation without the marketplace system, use **plugin-kit** - an interactive terminal UI.
34+
35+
### Installing the CLI
36+
37+
```bash
38+
./cli/install.sh
39+
```
40+
41+
This installs the `plugin-kit` binary to `~/.local/bin/` with a `pk` shorthand alias.
42+
43+
### Using the CLI
44+
45+
```bash
46+
plugin-kit # or just: pk
47+
```
48+
49+
The interactive wizard guides you through:
50+
51+
1. **Plugin Selection** - Search and select plugins using arrow keys and spacebar
52+
2. **Installation Location** - Choose `./.claude` (project-local) or a custom path
53+
3. **Conflict Resolution** - Handle existing plugins (override or skip)
54+
4. **Installation** - Plugins are extracted with their commands, agents, and skills
55+
56+
### Keyboard Controls
57+
58+
| Key | Action |
59+
|-----|--------|
60+
| `↑↓` | Navigate |
61+
| `Space` | Toggle selection |
62+
| `Enter` | Confirm |
63+
| `Esc` | Exit/Back |
64+
| Type | Search plugins |
65+
3166
## Using Plugins
3267

3368
Once the marketplace is added, install plugins with:
@@ -134,11 +169,13 @@ The marketplace is configured in `.claude-plugin/marketplace.json`. Key fields:
134169

135170
## Available Plugins
136171

137-
| Plugin Name | Description | Version |
138-
| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
139-
| [code-review-tools](./plugins/code-review-tools/README.md) | Review code changes commit-by-commit with custom rules support. Includes interactive setup and rule creation. | 2.1.1 |
140-
| [github-tools](./plugins/github-tools/README.md) | GitHub workflow tools for daily development. Analyze PR review comments and categorize what needs fixing. | 0.1.1 |
141-
| [spec-kit](./plugins/spec-kit/README.md) | Spec-Driven Development toolkit for Claude Code. Create specifications, plans, and tasks following a structured workflow from requirements to implementation. | 0.1.0 |
172+
| Plugin Name | Description | Version | Install |
173+
| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ---------- |
174+
| [code-review-tools](./plugins/code-review-tools/README.md) | Review code changes commit-by-commit with custom rules support. Includes interactive setup and rule creation. | 2.1.1 | Manual ¹ |
175+
| [github-tools](./plugins/github-tools/README.md) | GitHub workflow tools for daily development. Analyze PR review comments and categorize what needs fixing. | 0.1.1 | Either |
176+
| [spec-kit](./plugins/spec-kit/README.md) | Spec-Driven Development toolkit for Claude Code. Create specifications, plans, and tasks following a structured workflow from requirements to implementation. | 0.1.0 | Marketplace |
177+
178+
¹ **Manual installation recommended** - Supports custom review rules in the `references/` directory, which requires local file access not available via marketplace installation.
142179

143180
## Contributing
144181

0 commit comments

Comments
 (0)