Skip to content

Commit 57761df

Browse files
committed
docs: document skill install methods (npx skills, gh skill, plugin, npm)
Now that the canonical skill lives at the repo root, npx skills add and gh skill install resolve it. List all install paths in the README.
1 parent 2f85d9e commit 57761df

1 file changed

Lines changed: 21 additions & 7 deletions

File tree

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,17 +102,31 @@ bumpy publish # pack and publish, create git tags, push tags, and create GitHu
102102

103103
## AI Integration
104104

105-
Bumpy ships with an [agent skill](https://github.com/dmno-dev/bumpy/blob/main/skills/add-change/SKILL.md) that teaches LLMs how to create bump files.
105+
Bumpy ships with an [agent skill](https://github.com/dmno-dev/bumpy/blob/main/skills/add-change/SKILL.md) that teaches LLMs how to create bump files. It teaches the AI to examine git changes, identify affected packages, choose bump levels, and create bump files with `bumpy add` — and to keep existing bump files up to date as work continues on a branch, updating packages, bump levels, and summaries to reflect the final state of changes.
106106

107-
For Claude Code, install it as a plugin:
107+
### Installing the skill
108108

109-
```bash
110-
claude plugin install @varlock/bumpy
111-
```
109+
Pick whichever fits your setup:
110+
111+
- **[`skills`](https://github.com/vercel-labs/skills) (any agent — recommended)** — works with Claude Code, Cursor, OpenCode, Codex, and others:
112+
113+
```bash
114+
npx skills add dmno-dev/bumpy # update with: npx skills update
115+
```
116+
117+
- **GitHub CLI** (v2.90+):
118+
119+
```bash
120+
gh skill install dmno-dev/bumpy add-change # update with: gh skill update add-change
121+
```
122+
123+
- **Claude Code plugin:**
112124

113-
The skill is also bundled in the published npm package, so once bumpy is installed it lives at `node_modules/@varlock/bumpy/skills/add-change/SKILL.md` — version-pinned to your installed bumpy. Agents and tools that support the [SKILL.md](https://github.com/dmno-dev/bumpy/blob/main/skills/add-change/SKILL.md) format can reference it directly.
125+
```bash
126+
claude plugin install @varlock/bumpy
127+
```
114128

115-
The skill teaches the AI to examine git changes, identify affected packages, choose bump levels, and create bump files with `bumpy add`. It also instructs the AI to keep existing bump files up to date as work continues on a branch - updating packages, bump levels, and summaries to reflect the final state of changes.
129+
- **npm-bundled** the skill ships inside the published package, so once `@varlock/bumpy` is installed it lives at `node_modules/@varlock/bumpy/skills/add-change/SKILL.md`, version-pinned to your installed bumpy. Point any tool that consumes a `SKILL.md` path at it directly.
116130

117131
## Documentation
118132

0 commit comments

Comments
 (0)