Skip to content

Commit edc3990

Browse files
committed
docs: add local development section to README
Explains how to test local plugin changes across Claude Code (shell alias with --plugin-dir) and Codex (local path install) without disrupting production installs.
1 parent 4f292ee commit edc3990

1 file changed

Lines changed: 26 additions & 1 deletion

File tree

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,32 @@ bunx @every-env/compound-plugin install compound-engineering --to qwen
6060
bunx @every-env/compound-plugin install compound-engineering --to all
6161
```
6262

63-
Local dev:
63+
### Local Development
64+
65+
When developing and testing local changes to the plugin:
66+
67+
**Claude Code** — add a shell alias so your local copy loads alongside your normal plugins:
68+
69+
```bash
70+
# add to ~/.zshrc or ~/.bashrc
71+
alias claude-dev-ce='claude --plugin-dir ~/code/compound-engineering-plugin/plugins/compound-engineering'
72+
```
73+
74+
One-liner to append it:
75+
76+
```bash
77+
echo "alias claude-dev-ce='claude --plugin-dir ~/code/compound-engineering-plugin/plugins/compound-engineering'" >> ~/.zshrc
78+
```
79+
80+
Then run `claude-dev-ce` instead of `claude` to test your changes. Your production install stays untouched.
81+
82+
**Codex** — point the install command at your local path:
83+
84+
```bash
85+
bunx @every-env/compound-plugin install ./plugins/compound-engineering --to codex
86+
```
87+
88+
**Other targets** — same pattern, swap the target:
6489

6590
```bash
6691
bun run src/index.ts install ./plugins/compound-engineering --to opencode

0 commit comments

Comments
 (0)