Skip to content

Commit 250c2aa

Browse files
committed
docs: add usage instructions for different AI agents
Covers Claude Code, Cursor, GitHub Copilot, OpenAI Codex, Goose, Roo Code, Amp, Junie, and Gemini CLI with skill paths and invocation methods for each.
1 parent 2d1bca7 commit 250c2aa

1 file changed

Lines changed: 93 additions & 9 deletions

File tree

README.md

Lines changed: 93 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -86,16 +86,9 @@ cd ~/.claude/skills/java-code-upgrade # or .claude/skills/java-code-upgrade
8686
git pull
8787
```
8888

89-
### Other Agent Frameworks
89+
### Other Agents
9090

91-
This skill follows the [agentskills.io](https://agentskills.io) specification:
92-
93-
- `SKILL.md` — core agent instructions (entry point)
94-
- `references/` — pattern database loaded on demand via progressive disclosure
95-
- `scripts/find-pattern.py` — CLI tool for programmatic pattern search
96-
- `assets/` — output templates
97-
98-
Clone the repo and point the agent framework at `SKILL.md` as the skill entry point.
91+
This skill follows the [agentskills.io](https://agentskills.io) open standard and works with any compatible agent. See [Usage with Different Agents](#usage-with-different-agents) below for agent-specific setup.
9992

10093
## Directory Structure
10194

@@ -124,6 +117,97 @@ java-code-upgrade/
124117
upgrade-report-template.md # Template for upgrade reports
125118
```
126119

120+
## Usage with Different Agents
121+
122+
This skill follows the [agentskills.io](https://agentskills.io) open standard. It auto-activates when relevant to Java modernization tasks, or can be invoked explicitly.
123+
124+
### Claude Code
125+
126+
| Scope | Path |
127+
|-------|------|
128+
| Personal (all projects) | `~/.claude/skills/java-code-upgrade/` |
129+
| Project | `.claude/skills/java-code-upgrade/` |
130+
131+
**Invoke:** Ask naturally ("modernize this Java code") or explicitly with `/java-code-upgrade`. Claude loads the skill automatically when relevant.
132+
133+
[Claude Code skills docs](https://code.claude.com/docs/en/skills)
134+
135+
### Cursor
136+
137+
| Scope | Path |
138+
|-------|------|
139+
| User (global) | `~/.cursor/skills/java-code-upgrade/` |
140+
| Project | `.cursor/skills/java-code-upgrade/` or `.agents/skills/java-code-upgrade/` |
141+
142+
**Invoke:** Ask naturally or use `/java-code-upgrade` in chat. Cursor auto-discovers skills at startup. You can also install from GitHub via **Settings > Rules > Add Rule > Remote Rule (Github)**.
143+
144+
[Cursor skills docs](https://cursor.com/docs/context/skills)
145+
146+
### GitHub Copilot / VS Code
147+
148+
| Scope | Path |
149+
|-------|------|
150+
| Personal | `~/.copilot/skills/java-code-upgrade/` or `~/.claude/skills/java-code-upgrade/` |
151+
| Project | `.github/skills/java-code-upgrade/` or `.claude/skills/java-code-upgrade/` |
152+
153+
**Invoke:** Copilot auto-discovers and loads skills when relevant to the task.
154+
155+
[Copilot skills docs](https://docs.github.com/en/copilot/concepts/agents/about-agent-skills)
156+
157+
### OpenAI Codex
158+
159+
| Scope | Path |
160+
|-------|------|
161+
| User | `~/.agents/skills/java-code-upgrade/` |
162+
| Project | `.agents/skills/java-code-upgrade/` |
163+
| System | `/etc/codex/skills/java-code-upgrade/` |
164+
165+
**Invoke:** Reference with `/skills` or `$` mention syntax, or let Codex auto-select based on task context.
166+
167+
[Codex skills docs](https://developers.openai.com/codex/skills/)
168+
169+
### Goose
170+
171+
| Scope | Path |
172+
|-------|------|
173+
| Global | `~/.config/goose/skills/java-code-upgrade/` or `~/.config/agents/skills/java-code-upgrade/` |
174+
| Project | `.goose/skills/java-code-upgrade/` or `.agents/skills/java-code-upgrade/` |
175+
176+
**Invoke:** Ask "Use the java-code-upgrade skill" or let Goose auto-activate when relevant.
177+
178+
[Goose skills docs](https://block.github.io/goose/docs/guides/context-engineering/using-skills/)
179+
180+
### Roo Code
181+
182+
| Scope | Path |
183+
|-------|------|
184+
| Global | `~/.roo/skills/java-code-upgrade/` or `~/.agents/skills/java-code-upgrade/` |
185+
| Project | `.roo/skills/java-code-upgrade/` or `.agents/skills/java-code-upgrade/` |
186+
187+
**Invoke:** Roo indexes all skills at startup and auto-activates when your request matches. No manual registration needed.
188+
189+
[Roo Code skills docs](https://docs.roocode.com/features/skills)
190+
191+
### Amp
192+
193+
| Scope | Path |
194+
|-------|------|
195+
| Project | `.agents/skills/java-code-upgrade/` |
196+
197+
[Amp skills docs](https://ampcode.com/manual#agent-skills)
198+
199+
### Junie (JetBrains)
200+
201+
[Junie skills docs](https://junie.jetbrains.com/docs/agent-skills.html)
202+
203+
### Gemini CLI
204+
205+
[Gemini CLI skills docs](https://geminicli.com/docs/cli/skills/)
206+
207+
### Other Agents
208+
209+
For any other [agentskills.io](https://agentskills.io)-compatible agent, place the skill directory where the agent discovers skills (typically `~/.agents/skills/` globally or `.agents/skills/` per-project). The `SKILL.md` file is the entry point. The agent loads references and scripts on demand via progressive disclosure.
210+
127211
## Usage Examples
128212

129213
### Search patterns by category

0 commit comments

Comments
 (0)