{{ message }}
Repository navigation
Expand file tree
/
Copy pathskills.py
More file actions
459 lines (388 loc) · 18.7 KB
/
Copy pathskills.py
File metadata and controls
459 lines (388 loc) · 18.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
# Copyright 2026 The HuggingFace Team. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""`diffusers-cli skills` — install Agent Skills bundles.
Skill bundles live under `.ai/skills/<name>/` in the diffusers repo and follow the Agent Skills standard: a directory
containing `SKILL.md` (plus optional resources), including the `references/` copies of the guides it cites. Claude Code
gets a plugin bundle under `.claude/skills/`; Codex and Cursor get `.agents/skills/<name>/`.
"""
from __future__ import annotations
import json
import os
import re
import shutil
import textwrap
from argparse import ArgumentParser, Namespace, _SubParsersAction
from pathlib import Path
import httpx
from huggingface_hub.cli._output import out
from ..utils import logging
from ..utils.constants import DIFFUSERS_REQUEST_TIMEOUT
from . import BaseDiffusersCLICommand
logger = logging.get_logger("diffusers-cli/skills")
_REGISTRY_BASE = "https://api.github.com/repos/huggingface/diffusers/contents/.ai/skills"
_RAW_BASE = "https://raw.githubusercontent.com/huggingface/diffusers"
_REGISTRY_REF = "main"
# How a skill cites a guide, e.g. `](references/models.md)` or `` `references/testing.md` ``. The install copies exactly
# the guides named this way, so a skill only has to cite one to get it.
_CITATION = re.compile(r"(?<![./\w])references/([\w-]+\.md)")
# Native skill-discovery paths per agent. Claude Code reads only `.claude/skills/`; Codex and
# Cursor read `.agents/skills/` (Cursor also honors `.claude/skills/` via compat, but installing
# to `.agents/skills/` is the portable choice for both).
_CLAUDE_SKILLS_DIR = Path(".claude") / "skills"
_AGENTS_SKILLS_DIR = Path(".agents") / "skills"
# Env vars set by each agent when it launches the CLI. Values are the install path to use.
_AGENT_ENV_TO_DIR: dict[str, Path] = {
"CLAUDECODE": _CLAUDE_SKILLS_DIR,
"CLAUDE_CODE": _CLAUDE_SKILLS_DIR,
"CODEX_SANDBOX": _AGENTS_SKILLS_DIR,
"CURSOR_AI": _AGENTS_SKILLS_DIR,
}
# When no agent env var is set, install to every native path so whichever agent the user
# later switches to picks the skill up.
_ALL_INSTALL_DIRS: tuple[Path, ...] = (_CLAUDE_SKILLS_DIR, _AGENTS_SKILLS_DIR)
# Empty marker dropped inside each installed skill dir so `update` can distinguish our
# installs from user-placed skills at the same paths.
_MANAGED_MARKER_FILE = ".diffusers-skill-managed"
# Claude Code loads any directory under a skills root that carries a `.claude-plugin/plugin.json`
# as a plugin, which namespaces the skills it holds as `/diffusers:<name>` and matches what the
# published plugin gives contributors. Codex and Cursor have no equivalent, so they keep the plain
# one-skill-per-directory layout their discovery expects.
_PLUGIN_NAME = "diffusers"
_PLUGIN_MANIFEST = {
"name": _PLUGIN_NAME,
"description": "Conventions and task skills for contributing to diffusers",
}
# ---------------------------------------------------------------------------
# Registry fetch
# ---------------------------------------------------------------------------
def _registry_url(name: str = "") -> str:
"""API URL for the registry root, or for a single skill bundle when `name` is given."""
path = f"/{name}" if name else ""
return f"{_REGISTRY_BASE}{path}?ref={_REGISTRY_REF}"
def _skill_md_url(name: str) -> str:
"""Raw URL of a skill's SKILL.md, so `list` can read descriptions without walking each bundle."""
return f"{_RAW_BASE}/{_REGISTRY_REF}/.ai/skills/{name}/SKILL.md"
def _fetch_json(url: str) -> list[dict]:
try:
resp = httpx.get(url, timeout=DIFFUSERS_REQUEST_TIMEOUT)
resp.raise_for_status()
return resp.json()
except httpx.HTTPStatusError as e:
if e.response.status_code == 404:
raise SystemExit(f"Not found in registry: {url}") from e
raise SystemExit(f"Registry fetch failed: HTTP {e.response.status_code} {e.response.reason_phrase}") from e
except httpx.HTTPError as e:
raise SystemExit(f"Could not reach registry: {e}") from e
def _walk_skill_files(name: str) -> list[tuple[str, str]]:
files: list[tuple[str, str]] = []
def _walk(api_url: str, prefix: str) -> None:
for entry in _fetch_json(api_url):
if entry["type"] == "file":
files.append((f"{prefix}{entry['name']}", entry["download_url"]))
elif entry["type"] == "dir":
_walk(entry["url"], f"{prefix}{entry['name']}/")
_walk(_registry_url(name), "")
return files
def _skill_description(skill_md: str) -> str:
"""The `description` from a SKILL.md YAML frontmatter, collapsed onto one line.
Handles both `description: text` and the folded `description: >` form the skills in this repo use. Returns an empty
string when the file has no frontmatter or no description.
"""
lines = skill_md.splitlines()
if not lines or lines[0].strip() != "---":
return ""
for index, line in enumerate(lines[1:], start=1):
if line.strip() == "---":
return ""
if not line.startswith("description:"):
continue
value = line[len("description:") :].strip()
if value and value not in (">", "|", ">-", "|-"):
return value
folded = []
for continuation in lines[index + 1 :]:
if continuation.strip() == "---" or not continuation.startswith((" ", "\t")):
break
folded.append(continuation.strip())
return " ".join(folded)
return ""
def _download_skill_bundle(name: str) -> dict[str, bytes]:
files = _walk_skill_files(name)
if not files:
raise SystemExit(f"Skill '{name}' has no files in the registry.")
bundle: dict[str, bytes] = {}
for rel_path, url in files:
resp = httpx.get(url, timeout=DIFFUSERS_REQUEST_TIMEOUT)
resp.raise_for_status()
bundle[rel_path] = resp.content
return bundle
# ---------------------------------------------------------------------------
# Install / discovery
# ---------------------------------------------------------------------------
def _detect_install_dirs() -> tuple[Path, ...]:
"""Pick where to install based on the launching agent.
If we detect a specific agent from its env var, install only there. If nothing is detected, install to every native
path so any agent picks the skill up later.
"""
for env_var, skills_dir in _AGENT_ENV_TO_DIR.items():
if os.environ.get(env_var):
return (skills_dir,)
return _ALL_INSTALL_DIRS
def _skill_dir(root: Path, skills_dir: Path, name: str) -> Path:
"""Where a single skill lands, which differs by target: a plugin bundle for Claude Code, a bare
directory for Codex and Cursor."""
if skills_dir == _CLAUDE_SKILLS_DIR:
return root / skills_dir / _PLUGIN_NAME / "skills" / name
return root / skills_dir / name
def _install_references(skill_dir: Path, skill_md: bytes) -> None:
"""Copy the guides a skill cites into its own `references/` directory.
A skill cites a guide as `references/<guide>.md`, so the guides it needs are exactly the ones its SKILL.md names.
The repo keeps one copy of each under `.ai/references/`; an install gets its own so the skill is self-contained.
"""
references_dir = skill_dir / "references"
for guide in sorted(set(_CITATION.findall(skill_md.decode()))):
resp = httpx.get(f"{_RAW_BASE}/{_REGISTRY_REF}/.ai/references/{guide}", timeout=DIFFUSERS_REQUEST_TIMEOUT)
resp.raise_for_status()
references_dir.mkdir(parents=True, exist_ok=True)
(references_dir / guide).write_bytes(resp.content)
def _install_skill(name: str, bundle: dict[str, bytes], root: Path, skills_dir: Path, force: bool) -> Path:
skill_dir = _skill_dir(root, skills_dir, name)
if skill_dir.exists():
if not force:
raise SystemExit(f"Skill already installed at {skill_dir}. Use --force to reinstall.")
shutil.rmtree(skill_dir)
skill_dir.mkdir(parents=True, exist_ok=True)
for rel_path, data in bundle.items():
target = skill_dir / rel_path
target.parent.mkdir(parents=True, exist_ok=True)
target.write_bytes(data)
(skill_dir / _MANAGED_MARKER_FILE).touch()
_install_references(skill_dir, bundle["SKILL.md"])
if skills_dir == _CLAUDE_SKILLS_DIR:
manifest = root / skills_dir / _PLUGIN_NAME / ".claude-plugin" / "plugin.json"
manifest.parent.mkdir(parents=True, exist_ok=True)
manifest.write_text(json.dumps(_PLUGIN_MANIFEST, indent=2) + "\n")
return skill_dir
def _has_local_changes(skill_dir: Path, bundle: dict[str, bytes]) -> bool:
"""True if the installed skill has any file that differs from `bundle` or has extra files.
The marker file and the copied `references/` guides are ignored — neither comes from the skill bundle. Compares raw
bytes so a whitespace-only edit still counts as dirty.
"""
on_disk: dict[str, bytes] = {}
for path in skill_dir.rglob("*"):
if not path.is_file():
continue
rel = str(path.relative_to(skill_dir))
if rel.startswith("references/"):
continue
if rel == _MANAGED_MARKER_FILE:
continue
on_disk[rel] = path.read_bytes()
return on_disk != bundle
def _discover_installed(root: Path) -> list[tuple[Path, str]]:
"""Return `(skills_dir, name)` pairs for every managed install under `root`."""
found: list[tuple[Path, str]] = []
for skills_dir in _ALL_INSTALL_DIRS:
skills_root = root / skills_dir
if skills_dir == _CLAUDE_SKILLS_DIR:
skills_root = skills_root / _PLUGIN_NAME / "skills"
if not skills_root.exists():
continue
for d in sorted(skills_root.iterdir()):
if d.is_dir() and (d / _MANAGED_MARKER_FILE).exists():
found.append((skills_dir, d.name))
return found
class SkillsCommand(BaseDiffusersCLICommand):
@staticmethod
def register_subcommand(subparsers: _SubParsersAction) -> None:
parser: ArgumentParser = subparsers.add_parser(
"skills",
help="Manage Agent Skills for AI assistants.",
usage="\n diffusers-cli skills <add|list|update|preview> [options]",
)
parser._optionals.title = "Options"
actions = parser.add_subparsers(dest="skills_action", required=True, metavar="<action>")
add = actions.add_parser("add", help="Download and install a skill.")
add.add_argument(
"name",
nargs="?",
default=None,
help="Skill name (e.g. diffusers-cli, custom-blocks). Omit and pass --all to install every skill.",
)
add.add_argument(
"--all",
dest="install_all",
action="store_true",
help="Install every skill in the registry. Mutually exclusive with a positional name.",
)
target = add.add_mutually_exclusive_group()
target.add_argument(
"--claude",
dest="install_dirs",
action="store_const",
const=(_CLAUDE_SKILLS_DIR,),
help="Install for Claude Code only, instead of detecting the agent from the environment.",
)
target.add_argument(
"--codex",
dest="install_dirs",
action="store_const",
const=(_AGENTS_SKILLS_DIR,),
help="Install for Codex only.",
)
target.add_argument(
"--cursor",
dest="install_dirs",
action="store_const",
const=(_AGENTS_SKILLS_DIR,),
help="Install for Cursor only.",
)
add.add_argument(
"--global",
"-g",
dest="install_global",
action="store_true",
help="Install globally (user-level) instead of in the current project directory.",
)
add.add_argument("--force", action="store_true", help="Overwrite existing skills in the destination.")
add.set_defaults(func=SkillsCommand)
list_action = actions.add_parser("list", help="List available skills in the registry.")
list_action.set_defaults(func=SkillsCommand)
update = actions.add_parser("update", help="Re-download and reinstall managed skills.")
update.add_argument(
"name",
nargs="?",
default=None,
help="Optional installed skill name to update. Omit to update every managed skill.",
)
update.add_argument(
"--global",
"-g",
dest="install_global",
action="store_true",
help="Update skills installed globally (user-level) instead of the current project.",
)
update.add_argument(
"--force",
action="store_true",
help="Overwrite skills even if they have local modifications since install.",
)
update.set_defaults(func=SkillsCommand)
preview = actions.add_parser("preview", help="Print a skill's SKILL.md from the registry.")
preview.add_argument("name", help="Skill name to preview.")
preview.set_defaults(func=SkillsCommand)
def __init__(self, args: Namespace):
self.args = args
def run(self) -> None:
if self.args.skills_action == "add":
self._add()
elif self.args.skills_action == "list":
self._list()
elif self.args.skills_action == "update":
self._update()
elif self.args.skills_action == "preview":
self._preview()
def _add(self) -> None:
if self.args.install_all and self.args.name:
raise SystemExit("--all and a positional skill name are mutually exclusive.")
if not self.args.install_all and not self.args.name:
raise SystemExit("Pass a skill name (e.g. diffusers-cli) or --all to install every skill.")
root = Path.home() if self.args.install_global else Path.cwd()
install_dirs = self.args.install_dirs or _detect_install_dirs()
names = self._resolve_names()
installed: list[str] = []
failed: list[str] = []
for name in names:
try:
bundle = _download_skill_bundle(name)
for skills_dir in install_dirs:
_install_skill(name, bundle, root, skills_dir, self.args.force)
installed.append(name)
except (SystemExit, httpx.HTTPError) as e:
# Downgrade to a warning so one broken skill doesn't abort the batch.
logger.warning(f"Skipping skill {name!r}: {e}")
failed.append(name)
if not installed:
raise SystemExit(f"No skills installed. Failed: {failed}")
out.result(
f"Installed {len(installed)} skill(s)",
installed=", ".join(installed),
failed=", ".join(failed) if failed else None,
paths=", ".join(str(root / d) for d in install_dirs),
)
def _update(self) -> None:
root = Path.home() if self.args.install_global else Path.cwd()
installed = _discover_installed(root)
if self.args.name is not None:
installed = [entry for entry in installed if entry[1] == self.args.name]
if not installed:
raise SystemExit(f"No installed skill named {self.args.name!r} found under {root}.")
if not installed:
raise SystemExit(f"No managed skills found under {root}.")
# Group by skill name so we redownload each bundle once even if it's installed to
# multiple locations (e.g. both .claude/skills/ and .agents/skills/).
by_name: dict[str, list[Path]] = {}
for skills_dir, name in installed:
by_name.setdefault(name, []).append(skills_dir)
updated: list[str] = []
failed: list[str] = []
skipped: list[str] = []
for name, dirs in sorted(by_name.items()):
try:
bundle = _download_skill_bundle(name)
for skills_dir in dirs:
skill_dir = _skill_dir(root, skills_dir, name)
if not self.args.force and _has_local_changes(skill_dir, bundle):
logger.warning(
f"Skill {name!r} at {skill_dir} has local modifications; "
"skipping. Pass --force to overwrite them."
)
skipped.append(name)
continue
_install_skill(name, bundle, root, skills_dir, force=True)
updated.append(name)
except (SystemExit, httpx.HTTPError) as e:
logger.warning(f"Skipping skill {name!r}: {e}")
failed.append(name)
out.result(
f"Updated {len(updated)} skill(s)",
updated=", ".join(updated),
skipped=", ".join(skipped) if skipped else None,
failed=", ".join(failed) if failed else None,
)
def _preview(self) -> None:
bundle = _download_skill_bundle(self.args.name)
skill_md = bundle.get("SKILL.md")
if skill_md is None:
raise SystemExit(f"Skill {self.args.name!r} has no SKILL.md in the registry.")
print(skill_md.decode())
def _list(self) -> None:
entries = _fetch_json(_registry_url())
names = sorted(e["name"] for e in entries if e["type"] == "dir" and not e["name"].startswith("."))
if not names:
raise SystemExit("No skills found in registry.")
# Descriptions run several sentences, so they get a wrapped block under each name rather than a table cell.
width = min(shutil.get_terminal_size().columns, 100)
installed = {name for _, name in _discover_installed(Path.cwd())}
for name in names:
resp = httpx.get(_skill_md_url(name), timeout=DIFFUSERS_REQUEST_TIMEOUT)
resp.raise_for_status()
description = _skill_description(resp.text)
print(f"\n{name}{' (installed)' if name in installed else ''}")
print(textwrap.fill(description, width=width, initial_indent=" ", subsequent_indent=" "))
def _resolve_names(self) -> list[str]:
if self.args.install_all:
entries = _fetch_json(_registry_url())
return sorted(e["name"] for e in entries if e["type"] == "dir" and not e["name"].startswith("."))
return [self.args.name]
You can’t perform that action at this time.