1.4 KiB
1.4 KiB
| summary | read_when | ||
|---|---|---|---|
| Skill folder format, required files, allowed file types, limits. |
|
Skill format
On disk
A skill is a folder.
Required:
SKILL.md(orskill.md)
Optional:
- any supporting text-based files (see “Allowed files”)
.clawdhubignore(ignore patterns for publish/sync).gitignore(also honored)
Local install metadata (written by the CLI):
<skill>/.clawdhub/origin.json
Workdir install state (written by the CLI):
<workdir>/.clawdhub/lock.json
SKILL.md
- Markdown with optional YAML frontmatter.
- The server extracts metadata from frontmatter during publish.
descriptionis used as the skill summary in the UI/search.
Allowed files
Only “text-based” files are accepted by publish.
- Extension allowlist is in
packages/schema/src/textFiles.ts(TEXT_FILE_EXTENSIONS). - Content types starting with
text/are treated as text; plus a small allowlist (JSON/YAML/TOML/JS/TS/Markdown/SVG).
Limits (server-side):
- Total bundle size: 50MB.
- Embedding text includes
SKILL.md+ up to ~40 non-.mdfiles (best-effort cap).
Slugs
- Derived from folder name by default.
- Must be lowercase and URL-safe:
^[a-z0-9][a-z0-9-]*$.
Versioning + tags
- Each publish creates a new version (semver).
- Tags are string pointers to a version;
latestis commonly used.