Skip to content

Commit 7bed6b7

Browse files
committed
feat(plugin): add compatibility and deprecation path for legacy bare commands (#1289)
- Create migration guide documenting bare → codingbuddy:* transition - Update README build template with namespaced commands and migration notice - Recommend PLAN/ACT/EVAL/AUTO keywords as lowest-friction workflow entry - Legacy bare commands remain functional during transition period Closes #1289
1 parent fddc741 commit 7bed6b7

3 files changed

Lines changed: 98 additions & 28 deletions

File tree

packages/claude-code-plugin/README.md

Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# CodingBuddy Claude Code Plugin
44

5-
> Version 5.1.3
5+
> Version 5.2.0
66
77
Multi-AI Rules for consistent coding practices - PLAN/ACT/EVAL workflow, specialist agents, and reusable skills for systematic development.
88

@@ -25,11 +25,21 @@ claude plugin add codingbuddy
2525
- **AUTO**: Autonomous PLAN → ACT → EVAL cycle
2626

2727
### Commands
28-
- `/plan` - Enter PLAN mode
29-
- `/act` - Enter ACT mode
30-
- `/eval` - Enter EVAL mode
31-
- `/auto` - Enter AUTO mode
32-
- `/checklist` - Generate contextual checklists
28+
- `/codingbuddy:plan` - Enter PLAN mode
29+
- `/codingbuddy:act` - Enter ACT mode
30+
- `/codingbuddy:eval` - Enter EVAL mode
31+
- `/codingbuddy:auto` - Enter AUTO mode
32+
- `/codingbuddy:checklist` - Generate contextual checklists
33+
- `/codingbuddy:buddy` - Show project status and next actions
34+
35+
> **Tip:** Type `PLAN`, `ACT`, `EVAL`, or `AUTO` as keywords for the fastest workflow entry.
36+
37+
### Command Migration
38+
39+
Legacy bare commands (`/plan`, `/act`, `/eval`, `/auto`, `/buddy`, `/checklist`) are deprecated.
40+
They continue to work during the transition period, but all new commands use the `codingbuddy:*` namespace.
41+
42+
See [Migration Guide](./docs/migration-guide.md) for details.
3343

3444
### Specialist Agents
3545
35 AI agents for different domains:
@@ -46,24 +56,9 @@ Reusable workflows for consistent development:
4656
- Refactoring
4757
- And more...
4858

49-
## Feature Availability
50-
51-
| Feature | Standalone | With MCP |
52-
|---------|-----------|----------|
53-
| Mode detection (PLAN/ACT/EVAL/AUTO) |||
54-
| Basic agent recommendation |||
55-
| TDD workflow guidance |||
56-
| HUD / StatusLine |||
57-
| Session stats & history |||
58-
| Specialist agent dispatch |||
59-
| Context tracking (cross-session) |||
60-
| Parallel agent execution |||
61-
| Contextual checklists |||
62-
| Rule search & impact tracking |||
63-
64-
## MCP Integration (Recommended)
59+
## MCP Integration (Required)
6560

66-
This plugin works standalone but benefits from the CodingBuddy MCP server for full functionality:
61+
This plugin requires the CodingBuddy MCP server for full functionality:
6762

6863
```bash
6964
npm install -g codingbuddy
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Command Migration Guide
2+
3+
## Overview
4+
5+
CodingBuddy is migrating from bare slash commands (`/plan`, `/act`, etc.) to namespaced commands (`/codingbuddy:plan`, `/codingbuddy:act`, etc.) to prevent collisions with Claude Code built-in commands.
6+
7+
**Bare commands continue to work during the transition period.** No immediate action is required.
8+
9+
## Recommended: Use Keywords Instead
10+
11+
The lowest-friction workflow uses **keywords** — plain text typed at the start of your message. Keywords are not slash commands and require no namespace:
12+
13+
| Keyword | Effect |
14+
| -------- | ----------------------------------- |
15+
| `PLAN` | Enter planning mode |
16+
| `ACT` | Enter implementation mode |
17+
| `EVAL` | Enter evaluation mode |
18+
| `AUTO` | Enter autonomous PLAN/ACT/EVAL cycle |
19+
20+
**Examples:**
21+
22+
```
23+
PLAN design auth feature
24+
ACT implement the login form
25+
EVAL review the auth module
26+
AUTO build user dashboard
27+
```
28+
29+
Keywords also support localized variants: Korean (`계획`/`실행`/`평가`/`자동`), Japanese (`計画`/`実行`/`評価`/`自動`), Chinese (`计划`/`执行`/`评估`/`自动`), Spanish (`PLANIFICAR`/`ACTUAR`/`EVALUAR`/`AUTOMÁTICO`).
30+
31+
## Command Mapping
32+
33+
If you prefer slash commands, use the namespaced form:
34+
35+
| Legacy (bare) | Namespaced (new) | Status |
36+
| -------------- | -------------------------- | ---------------- |
37+
| `/plan` | `/codingbuddy:plan` | migration target |
38+
| `/act` | `/codingbuddy:act` | migration target |
39+
| `/eval` | `/codingbuddy:eval` | migration target |
40+
| `/auto` | `/codingbuddy:auto` | migration target |
41+
| `/buddy` | `/codingbuddy:buddy` | migration target |
42+
| `/checklist` | `/codingbuddy:checklist` | migration target |
43+
44+
## Timeline
45+
46+
1. **Now**: Both bare and namespaced commands work. Keywords are the recommended entry point.
47+
2. **Transition**: Bare commands are deprecated but functional. New commands use `codingbuddy:*` only.
48+
3. **Future**: Once Claude Code fully supports `plugin:command` namespace resolution, bare aliases will be removed.
49+
50+
## What Changed and Why
51+
52+
Claude Code reserves certain command names as built-ins (e.g., `/help`, `/clear`, `/review`). To avoid collisions and clearly identify CodingBuddy functionality, all plugin commands now use the `codingbuddy:` namespace prefix.
53+
54+
See [namespace-policy.md](./namespace-policy.md) for the full policy.
55+
56+
## FAQ
57+
58+
**Q: Do I need to change anything right now?**
59+
A: No. Bare commands still work. Switch to keywords or namespaced commands at your convenience.
60+
61+
**Q: What is the recommended approach?**
62+
A: Use keywords (`PLAN`, `ACT`, `EVAL`, `AUTO`). They are the fastest and most portable workflow entry point.
63+
64+
**Q: Will new commands have bare aliases?**
65+
A: No. All new commands use the `codingbuddy:*` namespace exclusively.

packages/claude-code-plugin/scripts/build.ts

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,21 @@ claude plugin add codingbuddy
7272
- **AUTO**: Autonomous PLAN → ACT → EVAL cycle
7373
7474
### Commands
75-
- \`/plan\` - Enter PLAN mode
76-
- \`/act\` - Enter ACT mode
77-
- \`/eval\` - Enter EVAL mode
78-
- \`/auto\` - Enter AUTO mode
79-
- \`/checklist\` - Generate contextual checklists
75+
- \`/codingbuddy:plan\` - Enter PLAN mode
76+
- \`/codingbuddy:act\` - Enter ACT mode
77+
- \`/codingbuddy:eval\` - Enter EVAL mode
78+
- \`/codingbuddy:auto\` - Enter AUTO mode
79+
- \`/codingbuddy:checklist\` - Generate contextual checklists
80+
- \`/codingbuddy:buddy\` - Show project status and next actions
81+
82+
> **Tip:** Type \`PLAN\`, \`ACT\`, \`EVAL\`, or \`AUTO\` as keywords for the fastest workflow entry.
83+
84+
### Command Migration
85+
86+
Legacy bare commands (\`/plan\`, \`/act\`, \`/eval\`, \`/auto\`, \`/buddy\`, \`/checklist\`) are deprecated.
87+
They continue to work during the transition period, but all new commands use the \`codingbuddy:*\` namespace.
88+
89+
See [Migration Guide](./docs/migration-guide.md) for details.
8090
8191
### Specialist Agents
8292
35 AI agents for different domains:

0 commit comments

Comments
 (0)