Skip to content

Commit c8d6fe1

Browse files
Add npx-based installation support (#75)
1 parent 9c86b61 commit c8d6fe1

3 files changed

Lines changed: 59 additions & 37 deletions

File tree

README.md

Lines changed: 49 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
> [!IMPORTANT]
2-
> **Tech Preview: Catalog under active development.** We’re building the catalog in the open, sharing progress as the foundations take shape. Expect frequent changes as skills, categories, and descriptions evolve.
3-
41
# AMD Skills
52

63
<div align="center">
@@ -25,34 +22,43 @@ AMD Skills provide agents with knowledge, scripts, and conventions for working w
2522

2623
Skills in this repository follow the standardized [Agent Skills](https://github.com/anthropics/skills) format and are designed to interoperate with the major coding agents like Cursor, Claude Code, OpenAI Codex, and Gemini CLI.
2724

28-
## Installation
25+
> [!IMPORTANT]
26+
> **Tech Preview:** We’re building the catalog in the open, sharing progress as the foundations take shape. Expect frequent changes as skills, categories, and descriptions evolve.
2927
30-
AMD Skills will soon be installable directly in Claude/Cursor/Codex and other agents through marketplace integration.
3128

32-
While we work marketplace integration, please refer to our [Manual installation steps](#manual-installation).
3329

34-
## What is a skill?
30+
## Installation
3531

36-
A skill is a self-contained folder that bundles everything an agent needs to perform a focused task: instructions, helper scripts, prompts, templates, and references. At its core is a `SKILL.md` file with YAML frontmatter, a `name`, and a short `description` that tells the agent *when* the skill should activate, followed by the guidance the agent reads while the skill is in use.
32+
Install AMD Skills with the [`skills` CLI](https://github.com/vercel-labs/skills) via `npx`. No clone or manual copying required.
3733

34+
```bash
35+
npx skills add amd/skills
3836
```
39-
skills/
40-
rocm-doctor/
41-
SKILL.md
42-
skill-card.md
43-
scripts/
44-
references/
37+
38+
This prompts you to pick a skill and an install destination. To install a specific skill into specific agents, pass `--skill` with one or more `--agent` flags (e.g. `cursor`, `claude-code`, `codex`):
39+
40+
```bash
41+
npx skills add amd/skills --skill local-ai-use --agent claude-code
4542
```
4643

47-
When an agent decides a skill is relevant (or you invoke it explicitly), it loads that `SKILL.md` and follows the instructions inside. Descriptions stay in context cheaply; the full body of a skill only loads when the task actually matches.
44+
Browse everything available before installing:
4845

49-
Every skill also ships a `skill-card.md`: a short, human-facing governance card (Description, Owner, License) that tells a reviewer what the skill is and who stands behind it without reading the source. See [docs/skill-cards.md](docs/skill-cards.md).
46+
```bash
47+
npx skills add amd/skills --list
48+
```
5049

51-
## Why a skill, not a doc?
50+
Prefer to do it by hand? See [Manual installation](#manual-installation).
5251

53-
Documentation describes an API surface: every flag, every option, neutral by design. A skill encodes the opinionated path: which flags, which container image, which `gfx` target, which environment variables, in what order. It captures the decisions a senior AMD engineer makes without thinking, in a form the agent can apply consistently across teams and repositories.
52+
## Using a skill
5453

55-
Skills earn their keep on repeated, opinionated workflows, exactly where the AMD stack lives.
54+
Once a skill is installed, reference it in plain language while talking to your agent. For example:
55+
56+
- "Use AMD Skills to learn how to generate images locally instead of burning cloud tokens."
57+
- "Use AMD Skills to deploy this LLM for inference on my AMD Instinct GPUs."
58+
59+
In most cases the agent picks the right skill on its own from the description; explicit invocation is a fallback, not a requirement.
60+
61+
For hands-on, step-by-step guides that show a skill in action, see the [walkthroughs](walkthroughs/README.md).
5662

5763
## The catalog
5864

@@ -75,7 +81,7 @@ Cross-stack skills, from client to cloud.
7581
| Skill | What it does | Source |
7682
| --- | --- | --- |
7783
| `rocm-doctor` | Diagnose ROCm / PyTorch / llama.cpp failures on AMD GPUs against a fixed list of known misconfigurations. | _planned_ |
78-
| `llm-kernel-optimizer` (`hyperloom`) | Autonomously optimizes LLM inference on AMD GPUs. | _planned_ |
84+
| `hyperloom-kernel-optimizer` | Autonomously optimizes LLM inference on AMD GPUs. | _planned_ |
7985
| `vllm-semantic-router` | Setup a vLLM router that semantically maps your request to the best available platform. | _planned_ |
8086

8187
### Server-Native
@@ -88,6 +94,29 @@ Run and optimize on AMD Instinct.
8894
| [`magpie-kernel-evaluator`](skills/magpie-kernel-evaluator/SKILL.md) | Evaluate GPU kernel correctness and performance, compare kernel implementations, and benchmark vLLM / SGLang inference with profiling, TraceLens, and torch-trace gap analysis. | [Magpie](https://github.com/AMD-AGI/Magpie) |
8995
| [`tracelens-analysis-orchestrator`](skills/tracelens-analysis-orchestrator/SKILL.md) | Orchestrate modular PyTorch profiler trace analysis with TraceLens: generate perf reports, run system-level and compute-kernel subagents in parallel, and write a prioritized stakeholder report. | [TraceLens](https://github.com/AMD-AGI/TraceLens) |
9096

97+
## What is a skill?
98+
99+
A skill is a self-contained folder that bundles everything an agent needs to perform a focused task: instructions, helper scripts, prompts, templates, and references. At its core is a `SKILL.md` file with YAML frontmatter, a `name`, and a short `description` that tells the agent *when* the skill should activate, followed by the guidance the agent reads while the skill is in use.
100+
101+
```
102+
skills/
103+
rocm-doctor/
104+
SKILL.md
105+
skill-card.md
106+
scripts/
107+
references/
108+
```
109+
110+
When an agent decides a skill is relevant (or you invoke it explicitly), it loads that `SKILL.md` and follows the instructions inside. Descriptions stay in context cheaply; the full body of a skill only loads when the task actually matches.
111+
112+
Every skill also ships a `skill-card.md`: a short, human-facing governance card (Description, Owner, License) that tells a reviewer what the skill is and who stands behind it without reading the source. See [docs/skill-cards.md](docs/skill-cards.md).
113+
114+
## Why a skill, not a doc?
115+
116+
Documentation describes an API surface: every flag, every option, neutral by design. A skill encodes the opinionated path: which flags, which container image, which `gfx` target, which environment variables, in what order. It captures the decisions a senior AMD engineer makes without thinking, in a form the agent can apply consistently across teams and repositories.
117+
118+
Skills earn their keep on repeated, opinionated workflows, exactly where the AMD stack lives.
119+
91120

92121
## A federated catalog
93122

@@ -148,17 +177,6 @@ cp -r amd-skills/skills/local-ai-use <agent-skills-dir>/
148177
| Claude Code | `~/.claude/skills/` / `.claude/skills/` |
149178
| Codex | `$HOME/.agents/skills` / `$REPO_ROOT/.agents/skills` |
150179

151-
## Using a skill
152-
153-
Once a skill is installed, reference it in plain language while talking to your agent. For example:
154-
155-
- "Use AMD Skills to integrate local AI capabilities into my app with Embeddable Lemonade."
156-
- "Use AMD Skills to convert these CUDA kernels and flag anything that needs manual review."
157-
158-
In most cases the agent picks the right skill on its own from the description; explicit invocation is a fallback, not a requirement.
159-
160-
For hands-on, step-by-step guides that show a skill in action, see the [walkthroughs](walkthroughs/README.md).
161-
162180
## Contributing a skill
163181

164182
We welcome contributions from AMD engineers and selected partners. Two paths, matching how the catalog is organized:

walkthroughs/local-ai-app-integration.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,12 @@ cd dictate
2727

2828
## Step 3 - Enabling claude to see `local-ai-app-integration`
2929

30-
In the future this will be enabled directly through claude's marketplace. For now, we have to manually add it.
30+
* Install the skill with the [`skills` CLI](https://github.com/vercel-labs/skills):
31+
32+
```bash
33+
npx skills add amd/skills --skill local-ai-app-integration --agent claude-code
34+
```
3135

32-
* Clone `https://github.com/amd/skills`
33-
* Move the `local-ai-app-integration` skill from the repo to `.claude/skills/`
3436
* Run `claude "Which skills can you see?" --model opus`. You should see a list of skills that includes `local-ai-app-integration`.
3537

3638
## Step 4 - Running the skill

walkthroughs/local-ai-use.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,12 @@ The goal of this skill is to teach your AI agent to use image generation, text g
1010

1111
## Step 2 - Enabling claude to see `local-ai-use`
1212

13-
In the future this will be enabled directly through claude's marketplace. For now, we have to manually add it.
13+
* Install the skill with the [`skills` CLI](https://github.com/vercel-labs/skills):
14+
15+
```bash
16+
npx skills add amd/skills --skill local-ai-use --agent claude-code
17+
```
1418

15-
* Clone `https://github.com/amd/skills`
16-
* Move the `local-ai-use` skill from the repo to `.claude/skills/`
1719
* Run `claude "Which skills can you see?" --model sonnet`. You should see a list of skills that includes `local-ai-use`.
1820

1921
## Step 3 - Running the skill

0 commit comments

Comments
 (0)