docs: rebuild KB in OKF v0.1 with live-verified facts
Copy of the legacy ~/.pi/agent/docs tree rebuilt as the command-center knowledge base: concept files promoted to path identity, index listings stripped of frontmatter, all wikilinks/relative links resolved, every checkable claim verified against the live fleet (Dankserver = Ryzen 7 7700X + RTX 3090; Strix Halo is Dankclaw), unverifiable claims tagged. kb-lint exits 0.
This commit is contained in:
1 parent
552d1ef8bf
commit
02883d3ed2
116 files changed
+13008
No files matched your search
@@ -0,0 +1,84 @@
|
||||
---
|
||||
type: reference
|
||||
title: Skills CLI Agent Support Matrix
|
||||
description: Complete list of 68+ supported coding agents, their --agent flags, and installation paths (project and global).
|
||||
tags:
|
||||
- unverified
|
||||
- skills
|
||||
- agents
|
||||
- compatibility
|
||||
timestamp: 2026-07-18
|
||||
verified: 2026-08-28
|
||||
---
|
||||
|
||||
# Agent Support
|
||||
|
||||
The CLI supports **68+ agents**. It automatically detects which coding agents you have installed. If none are detected, you'll be prompted to select which agents to install to.
|
||||
|
||||
## Full Agent Path Table
|
||||
|
||||
| Agent | `--agent` | Project Path | Global Path |
|
||||
|-------|-----------|--------------|-------------|
|
||||
| Amp, Replit, Universal | `amp`, `replit`, `universal` | `.agents/skills/` | `~/.config/agents/skills/` |
|
||||
| Claude Code | `claude-code` | `.claude/skills/` | `~/.claude/skills/` |
|
||||
| Cursor | `cursor` | `.agents/skills/` | `~/.cursor/skills/` |
|
||||
| Codex | `codex` | `.agents/skills/` | `~/.codex/skills/` |
|
||||
| OpenCode | `opencode` | `.agents/skills/` | `~/.config/opencode/skills/` |
|
||||
| Cline, Dexto, Kimi Code CLI, Loaf, Warp, Zed | `cline`, `dexto`, `kimi-code-cli`, `loaf`, `warp`, `zed` | `.agents/skills/` | `~/.agents/skills/` |
|
||||
| Gemini CLI | `gemini-cli` | `.agents/skills/` | `~/.gemini/skills/` |
|
||||
| GitHub Copilot | `github-copilot` | `.agents/skills/` | `~/.copilot/skills/` |
|
||||
| Pi | `pi` | `.pi/skills/` | `~/.pi/agent/skills/` |
|
||||
| Roo Code | `roo` | `.roo/skills/` | `~/.roo/skills/` |
|
||||
| Windsurf | `windsurf` | `.windsurf/skills/` | `~/.codeium/windsurf/skills/` |
|
||||
| Kiro CLI | `kiro-cli` | `.kiro/skills/` | `~/.kiro/skills/` |
|
||||
| Continue | `continue` | `.continue/skills/` | `~/.continue/skills/` |
|
||||
| Goose | `goose` | `.goose/skills/` | `~/.config/goose/skills/` |
|
||||
| OpenHands | `openhands` | `.openhands/skills/` | `~/.openhands/skills/` |
|
||||
| Trae | `trae` | `.trae/skills/` | `~/.trae/skills/` |
|
||||
| Qoder | `qoder` | `.qoder/skills/` | `~/.qoder/skills/` |
|
||||
| Qwen Code | `qwen-code` | `.qwen/skills/` | `~/.qwen/skills/` |
|
||||
| iFlow CLI | `iflow-cli` | `.iflow/skills/` | `~/.iflow/skills/` |
|
||||
| Deep Agents | `deepagents` | `.agents/skills/` | `~/.deepagents/agent/skills/` |
|
||||
| Droid / Factory AI | `droid` | `.factory/skills/` | `~/.factory/skills/` |
|
||||
| Firebender | `firebender` | `.agents/skills/` | `~/.firebender/skills/` |
|
||||
| Devin for Terminal | `devin` | `.devin/skills/` | `~/.config/devin/skills/` |
|
||||
| Kilo Code | `kilo` | `.kilocode/skills/` | `~/.kilocode/skills/` |
|
||||
| Crush | `crush` | `.crush/skills/` | `~/.config/crush/skills/` |
|
||||
| Anthropic Antigravity | `antigravity` | `.agents/skills/` | `~/.gemini/antigravity/skills/` |
|
||||
| Jazz | `jazz` | `.jazz/skills/` | `~/.jazz/skills/` |
|
||||
| Junie | `junie` | `.junie/skills/` | `~/.junie/skills/` |
|
||||
| Kode | `kode` | `.kode/skills/` | `~/.kode/skills/` |
|
||||
| Lingma | `lingma` | `.lingma/skills/` | `~/.lingma/skills/` |
|
||||
| Moxby | `moxby` | `.moxby/skills/` | `~/.moxby/skills/` |
|
||||
| Mux | `mux` | `.mux/skills/` | `~/.mux/skills/` |
|
||||
| Pochi | `pochi` | `.pochi/skills/` | `~/.pochi/skills/` |
|
||||
| AdaL | `adal` | `.adal/skills/` | `~/.adal/skills/` |
|
||||
| Neovate | `neovate` | `.neovate/skills/` | `~/.neovate/skills/` |
|
||||
| AiderDesk | `aider-desk` | `.aider-desk/skills/` | `~/.aider-desk/skills/` |
|
||||
| IBM Bob | `bob` | `.bob/skills/` | `~/.bob/skills/` |
|
||||
| CodeArts Agent | `codearts-agent` | `.codeartsdoer/skills/` | `~/.codeartsdoer/skills/` |
|
||||
| CodeBuddy | `codebuddy` | `.codebuddy/skills/` | `~/.codebuddy/skills/` |
|
||||
| Codemaker | `codemaker` | `.codemaker/skills/` | `~/.codemaker/skills/` |
|
||||
| Command Code | `command-code` | `.commandcode/skills/` | `~/.commandcode/skills/` |
|
||||
| Cortex Code | `cortex` | `.cortex/skills/` | `~/.snowflake/cortex/skills/` |
|
||||
| Eve | `eve` | `agent/skills/` | N/A (project-only) |
|
||||
| ForgeCode | `forgecode` | `.forge/skills/` | `~/.forge/skills/` |
|
||||
| Hermes Agent | `hermes-agent` | `.hermes/skills/` | `~/.hermes/skills/` |
|
||||
| inference.sh | `inference-sh` | `.inferencesh/skills/` | `~/.inferencesh/skills/` |
|
||||
| Kode | `kode` | `.kode/skills/` | `~/.kode/skills/` |
|
||||
| MCPJam | `mcpjam` | `.mcpjam/skills/` | `~/.mcpjam/skills/` |
|
||||
| Mistral Vibe | `mistral-vibe` | `.vibe/skills/` | `~/.vibe/skills/` |
|
||||
| Ona | `ona` | `.ona/skills/` | `~/.ona/skills/` |
|
||||
| PromptScript | `promptscript` | `.agents/skills/` | N/A (project-only) |
|
||||
| Reasonix | `reasonix` | `.reasonix/skills/` | `~/.reasonix/skills/` |
|
||||
| Rovo Dev | `rovodev` | `.rovodev/skills/` | `~/.rovodev/skills/` |
|
||||
| Tabnine CLI | `tabnine-cli` | `.tabnine/agent/skills/` | `~/.tabnine/agent/skills/` |
|
||||
| Terramind | `terramind` | `.terramind/skills/` | `~/.terramind/skills/` |
|
||||
| Tinycloud | `tinycloud` | `.tinycloud/skills/` | `~/.tinycloud/skills/` |
|
||||
| Zencoder, Zenflow | `zencoder`, `zenflow` | `.zencoder/skills/` | `~/.zencoder/skills/` |
|
||||
|
||||
> **Kiro CLI users:** The default agent automatically loads skills from `.kiro/skills/` and `~/.kiro/skills/` — no configuration needed.
|
||||
|
||||
## Related
|
||||
|
||||
* [Commands](/tools/vercel-labs-skills/commands.md) — Using the `--agent` flag with commands
|
||||
@@ -0,0 +1,116 @@
|
||||
---
|
||||
type: reference
|
||||
title: Skills CLI Commands
|
||||
description: Complete reference for all skills CLI commands — add, use, list, find, update, remove, init, experimental_install, experimental_sync.
|
||||
tags:
|
||||
- unverified
|
||||
- skills
|
||||
- cli
|
||||
- commands
|
||||
timestamp: 2026-07-18
|
||||
verified: 2026-08-28
|
||||
---
|
||||
|
||||
# Commands Reference
|
||||
|
||||
## `skills add` — Install Skills
|
||||
|
||||
Install skills from a source (git repo, URL, or local path) into your agent directories.
|
||||
|
||||
```bash
|
||||
npx skills add <source> [options]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Description |
|
||||
|--------|-------------|
|
||||
| `-g, --global` | Install to user directory (`~/`) instead of project (`./`) |
|
||||
| `-a, --agent <agents...>` | Target specific agents |
|
||||
| `-s, --skill <skills...>` | Install specific skills by name. Use `'*'` for all. |
|
||||
| `-l, --list` | List available skills without installing |
|
||||
| `--copy` | Copy files instead of symlinking |
|
||||
| `-y, --yes` | Skip all confirmation prompts |
|
||||
| `--all` | Install all skills to all agents without prompts |
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
npx skills add vercel-labs/agent-skills --list
|
||||
npx skills add vercel-labs/agent-skills --skill frontend-design --skill skill-creator
|
||||
npx skills add vercel-labs/agent-skills -a claude-code -a opencode
|
||||
npx skills add vercel-labs/agent-skills --all
|
||||
```
|
||||
|
||||
## `skills use` — Use Without Installing
|
||||
|
||||
Generate a prompt for one skill, or start a supported coding agent interactively with the skill loaded.
|
||||
|
||||
```bash
|
||||
npx skills use <source> [options]
|
||||
# Generate prompt only
|
||||
npx skills use vercel-labs/agent-skills@web-design-guidelines | claude
|
||||
# Use with specific agent
|
||||
npx skills use vercel-labs/agent-skills --skill web-design-guidelines --agent claude-code
|
||||
```
|
||||
|
||||
## `skills list` (alias: `ls`) — List Installed Skills
|
||||
|
||||
```bash
|
||||
npx skills list
|
||||
npx skills ls -g # Global only
|
||||
npx skills ls -a claude-code -a cursor
|
||||
```
|
||||
|
||||
## `skills find` — Search for Skills
|
||||
|
||||
```bash
|
||||
npx skills find # Interactive search
|
||||
npx skills find typescript # Search by keyword
|
||||
npx skills find react --owner vercel
|
||||
```
|
||||
|
||||
## `skills update` — Update Installed Skills
|
||||
|
||||
```bash
|
||||
npx skills update # All skills (interactive)
|
||||
npx skills update my-skill # Single skill
|
||||
npx skills update -g # Global only
|
||||
npx skills update -y # Non-interactive
|
||||
```
|
||||
|
||||
## `skills remove` (alias: `rm`) — Remove Installed Skills
|
||||
|
||||
```bash
|
||||
npx skills remove # Interactive
|
||||
npx skills remove web-design-guidelines
|
||||
npx skills remove --all # Remove everything
|
||||
```
|
||||
|
||||
## `skills init` — Create a New SKILL.md Template
|
||||
|
||||
```bash
|
||||
npx skills init # In current directory
|
||||
npx skills init my-skill # In a subdirectory
|
||||
```
|
||||
|
||||
## `skills experimental_install` — Restore from Lock File
|
||||
|
||||
```bash
|
||||
npx skills experimental_install
|
||||
```
|
||||
|
||||
## Aliases
|
||||
|
||||
| Alias | Full Command |
|
||||
|-------|-------------|
|
||||
| `skills a` | `skills add` |
|
||||
| `skills i` | `skills experimental_install` |
|
||||
| `skills install` (no args) | `skills experimental_install` |
|
||||
| `skills ls` | `skills list` |
|
||||
| `skills rm` | `skills remove` |
|
||||
|
||||
## Related
|
||||
|
||||
* [Source Formats](/tools/vercel-labs-skills/source-formats.md) — What sources you can use with add/use
|
||||
* [Installation Scope](/tools/vercel-labs-skills/installation-scope.md) — Global vs project
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
type: reference
|
||||
title: Skills CLI Environment Variables
|
||||
description: Environment variables — INSTALL_INTERNAL_SKILLS, DISABLE_TELEMETRY, DO_NOT_TRACK.
|
||||
tags:
|
||||
- unverified
|
||||
- skills
|
||||
- environment
|
||||
- telemetry
|
||||
timestamp: 2026-07-18
|
||||
verified: 2026-08-28
|
||||
---
|
||||
|
||||
# Environment Variables
|
||||
|
||||
| Variable | Description |
|
||||
|----------|-------------|
|
||||
| `INSTALL_INTERNAL_SKILLS` | Set to `1` or `true` to show and install skills marked as `internal: true` |
|
||||
| `DISABLE_TELEMETRY` | Set to disable anonymous usage telemetry |
|
||||
| `DO_NOT_TRACK` | Alternative way to disable telemetry |
|
||||
|
||||
```bash
|
||||
# Install internal skills
|
||||
INSTALL_INTERNAL_SKILLS=1 npx skills add vercel-labs/agent-skills --list
|
||||
```
|
||||
|
||||
## Telemetry
|
||||
|
||||
The CLI collects anonymous usage data to help improve the tool. No personal information is collected. Telemetry is automatically disabled in CI environments.
|
||||
|
||||
## Related
|
||||
|
||||
* [SKILL.md Format](/tools/vercel-labs-skills/skill-format.md) — `metadata.internal: true`
|
||||
@@ -0,0 +1,18 @@
|
||||
# Vercel Labs `skills` CLI
|
||||
|
||||
Complete list of 68+ supported coding agents, their --agent flags, and installation paths (project and global).
|
||||
|
||||
## Concept Files
|
||||
|
||||
| File | Type | Description |
|
||||
|------|------|-------------|
|
||||
| [agent-support.md](agent-support.md) | reference | Complete list of 68+ supported coding agents, their --agent flags, and instal... |
|
||||
| [commands.md](commands.md) | reference | Complete reference for all skills CLI commands — add, use, list, find, update... |
|
||||
| [env-variables.md](env-variables.md) | reference | Environment variables — INSTALL_INTERNAL_SKILLS, DISABLE_TELEMETRY, DO_NOT_TR... |
|
||||
| [installation-scope.md](installation-scope.md) | reference | Project vs global installation, symlink vs copy methods. |
|
||||
| [lock-file.md](lock-file.md) | reference | Version pinning and update checking via global and local lock files (.skill-l... |
|
||||
| [related-links.md](related-links.md) | reference | Links to the Agent Skills specification, skills directory, integration guide,... |
|
||||
| [skill-discovery.md](skill-discovery.md) | reference | How the skills CLI discovers SKILL.md files in repositories — flat layout, ca... |
|
||||
| [skill-format.md](skill-format.md) | reference | The required frontmatter fields, optional fields, internal skills, and struct... |
|
||||
| [source-formats.md](source-formats.md) | reference | All accepted source formats for skills add and use — GitHub shorthand, full U... |
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
type: reference
|
||||
title: Skills CLI Installation Scope
|
||||
description: Project vs global installation, symlink vs copy methods.
|
||||
tags:
|
||||
- unverified
|
||||
- skills
|
||||
- installation
|
||||
- scope
|
||||
timestamp: 2026-07-18
|
||||
verified: 2026-08-28
|
||||
---
|
||||
|
||||
# Installation Scope
|
||||
|
||||
## Project vs Global
|
||||
|
||||
| Scope | Flag | Location | Use Case |
|
||||
|-------|------|----------|----------|
|
||||
| **Project** | _(default)_ | `./<agent>/skills/` | Committed with your project, shared with team |
|
||||
| **Global** | `-g` | `~/<agent>/skills/` | Available across all projects |
|
||||
|
||||
## Symlink vs Copy
|
||||
|
||||
When installing interactively, you can choose:
|
||||
|
||||
| Method | Description |
|
||||
|--------|-------------|
|
||||
| **Symlink** _(Recommended)_ | Creates symlinks from each agent to a canonical copy. Single source of truth, easy updates. |
|
||||
| **Copy** | Creates independent copies for each agent. Use when symlinks are not supported. |
|
||||
|
||||
Use `--copy` to force copy mode.
|
||||
|
||||
## Related
|
||||
|
||||
* [Commands](/tools/vercel-labs-skills/commands.md) — add, use, list, remove commands
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
type: reference
|
||||
title: Skills CLI Lock File System
|
||||
description: Version pinning and update checking via global and local lock files (.skill-lock.json and skills-lock.json).
|
||||
tags:
|
||||
- unverified
|
||||
- skills
|
||||
- lockfile
|
||||
- versioning
|
||||
timestamp: 2026-07-18
|
||||
verified: 2026-08-28
|
||||
---
|
||||
|
||||
# Lock File System
|
||||
|
||||
The `skills` CLI uses a lock file system for version pinning and update checking.
|
||||
|
||||
## Lock File Locations
|
||||
|
||||
| Type | Path | Scope |
|
||||
|------|------|-------|
|
||||
| **Global lock** | `~/.agents/.skill-lock.json` | Global (user-wide) |
|
||||
| **Local lock** | `skills-lock.json` | Project (checked into version control) |
|
||||
|
||||
## How `skills check` and `skills update` Work
|
||||
|
||||
1. Read `~/.agents/.skill-lock.json` for installed skills
|
||||
2. Filter to GitHub-backed skills that have both `skillFolderHash` and `skillPath`
|
||||
3. For each skill, call `fetchSkillFolderHash(source, skillPath, token)`
|
||||
- Optional auth token from `GITHUB_TOKEN`, `GH_TOKEN`, or `gh auth token`
|
||||
4. `fetchSkillFolderHash` calls GitHub Trees API (`/git/trees/<branch>?recursive=1` for `main`, then `master` fallback)
|
||||
5. Compare latest folder tree SHA with lock file `skillFolderHash`; mismatch means update available
|
||||
6. `skills update` reinstalls changed skills by invoking the current CLI directly
|
||||
|
||||
## Lock File Format
|
||||
|
||||
- **Version:** v3
|
||||
- **Key field:** `skillFolderHash` — GitHub tree SHA for the skill folder
|
||||
- **Compatibility:** If reading an older lock file version, it is wiped. Users must reinstall skills to populate the new format.
|
||||
|
||||
## Related
|
||||
|
||||
* [Commands](/tools/vercel-labs-skills/commands.md) — check, update, experimental_install
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
type: reference
|
||||
title: Vercel Labs Skills — Related Links
|
||||
description: Links to the Agent Skills specification, skills directory, integration guide, and agent-specific skill documentation.
|
||||
tags:
|
||||
- unverified
|
||||
- skills
|
||||
- links
|
||||
- resources
|
||||
timestamp: 2026-07-18
|
||||
verified: 2026-08-28
|
||||
---
|
||||
|
||||
# Related Links
|
||||
|
||||
## Specification & Ecosystem
|
||||
|
||||
| Resource | URL |
|
||||
|----------|-----|
|
||||
| [Agent Skills Specification](https://agentskills.io) | agentskills.io/specification |
|
||||
| [Skills Directory](https://skills.sh) | skills.sh |
|
||||
| [Agent Skills Integration Guide](https://agentskills.io/integrate-skills) | agentskills.io/integrate-skills |
|
||||
| [Vercel Agent Skills Repository](https://github.com/vercel-labs/agent-skills) | github.com/vercel-labs/agent-skills |
|
||||
|
||||
## Agent-Specific Skill Documentation
|
||||
|
||||
| Agent | Documentation |
|
||||
|-------|--------------|
|
||||
| Amp | [Amp Skills Documentation](https://ampcode.com/manual#agent-skills) |
|
||||
| Claude Code | [Claude Code Skills Documentation](https://code.claude.com/docs/en/skills) |
|
||||
| Codex | [Codex Skills Documentation](https://developers.openai.com/codex/skills) (url unreachable 2026-08-28) |
|
||||
| Cursor | [Cursor Skills Documentation](https://cursor.com/docs/context/skills) |
|
||||
| Gemini CLI | [Gemini CLI Skills Documentation](https://geminicli.com/docs/cli/skills/) (url unreachable 2026-08-28) |
|
||||
| GitHub Copilot | [GitHub Copilot Agent Skills](https://docs.github.com/en/copilot/concepts/agents/about-agent-skills) |
|
||||
| OpenCode | [OpenCode Skills Documentation](https://opencode.ai/docs/skills) (url unreachable 2026-08-28) |
|
||||
| OpenHands | [OpenHands Skills Documentation](https://docs.openhands.ai/modules/usage/how-to/using-skills) (url unreachable 2026-08-28) |
|
||||
| Pi | [Pi Skills Documentation](https://github.com/earendil-works/pi) |
|
||||
| Roo Code | [Roo Code Skills Documentation](https://docs.roocode.com/features/skills) (url unreachable 2026-08-28) |
|
||||
| Windsurf | [Windsurf](https://www.codeium.com/windsurf) (url unreachable 2026-08-28) |
|
||||
|
||||
## Related
|
||||
|
||||
* [Agent Support](/tools/vercel-labs-skills/agent-support.md) — Full list of 68+ supported agents
|
||||
@@ -0,0 +1,63 @@
|
||||
---
|
||||
type: reference
|
||||
title: Skills CLI Skill Discovery
|
||||
description: How the skills CLI discovers SKILL.md files in repositories — flat layout, catalog layout, plugin manifests.
|
||||
tags:
|
||||
- unverified
|
||||
- skills
|
||||
- discovery
|
||||
- repository
|
||||
timestamp: 2026-07-18
|
||||
verified: 2026-08-28
|
||||
---
|
||||
|
||||
# Skill Discovery
|
||||
|
||||
The CLI searches for skills in these locations within a repository. Each skill container directory is walked:
|
||||
|
||||
- **One level deep** for the common flat layout: `skills/<name>/SKILL.md`
|
||||
- **One extra level deep** for catalog layouts: `skills/<category>/<name>/SKILL.md`
|
||||
|
||||
A `SKILL.md` discovered at the shallower level shadows anything nested below it. Use `--full-depth` to also discover `SKILL.md` files outside these container directories.
|
||||
|
||||
## Standard Discovery Locations
|
||||
|
||||
- `SKILL.md` in root directory (if present)
|
||||
- `skills/`
|
||||
- `skills/.curated/`
|
||||
- `skills/.experimental/`
|
||||
- `skills/.system/`
|
||||
- `.agents/skills/`
|
||||
- `.claude/skills/`
|
||||
- `.goose/skills/`
|
||||
- `.openhands/skills/`
|
||||
- `.pi/skills/`
|
||||
- And many more per-agent directories (see [Agent Support](/tools/vercel-labs-skills/agent-support.md))
|
||||
|
||||
## Plugin Manifest Discovery
|
||||
|
||||
If `.claude-plugin/marketplace.json` or `.claude-plugin/plugin.json` exists, skills declared in those files are also discovered. This enables compatibility with the [Claude Code plugin marketplace](https://code.claude.com/docs/en/plugin-marketplaces) ecosystem.
|
||||
|
||||
Example `marketplace.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"metadata": { "pluginRoot": "./plugins" },
|
||||
"plugins": [
|
||||
{
|
||||
"name": "my-plugin",
|
||||
"source": "my-plugin",
|
||||
"skills": ["./skills/review", "./skills/test"]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Skill paths declared in a manifest are searched at their declared depth.
|
||||
|
||||
If no skills are found in standard locations, a **recursive search** is performed as a fallback.
|
||||
|
||||
## Related
|
||||
|
||||
* [SKILL.md Format](/tools/vercel-labs-skills/skill-format.md) — What a discovered skill looks like
|
||||
* [Commands](/tools/vercel-labs-skills/commands.md) — add and use commands
|
||||
@@ -0,0 +1,70 @@
|
||||
---
|
||||
type: reference
|
||||
title: SKILL.md Format
|
||||
description: The required frontmatter fields, optional fields, internal skills, and structure for SKILL.md files.
|
||||
tags:
|
||||
- skills
|
||||
- SKILL.md
|
||||
- format
|
||||
- unverified
|
||||
verified: 2026-08-28
|
||||
|
||||
# SKILL.md Format
|
||||
|
||||
Skills are directories containing a `SKILL.md` file with YAML frontmatter.
|
||||
|
||||
## Basic Structure
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: my-skill
|
||||
description: What this skill does and when to use it
|
||||
---
|
||||
|
||||
# My Skill
|
||||
|
||||
Instructions for the agent to follow when this skill is activated.
|
||||
|
||||
## When to Use
|
||||
|
||||
Describe the scenarios where this skill is used.
|
||||
|
||||
## Steps
|
||||
|
||||
1. First, do this
|
||||
2. Then, do that
|
||||
```
|
||||
|
||||
## Required Frontmatter Fields
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| `name` | string | Unique identifier (lowercase, hyphens allowed) |
|
||||
| `description` | string | Brief explanation of what the skill does |
|
||||
|
||||
## Optional Frontmatter Fields
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| `metadata.internal` | boolean | Set to `true` to hide the skill from normal discovery. Requires `INSTALL_INTERNAL_SKILLS=1` |
|
||||
| `license` | string | License name or reference to bundled file |
|
||||
| `compatibility` | string | Environment requirements (max 500 chars) |
|
||||
| `metadata` | object | Arbitrary key-value mapping |
|
||||
| `allowed-tools` | string | Space-delimited list of pre-approved tools (experimental) |
|
||||
| `disable-model-invocation` | boolean | When `true`, skill is hidden from system prompt. Users must use `/skill:name` explicitly |
|
||||
|
||||
## Internal Skills Example
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: my-internal-skill
|
||||
description: An internal skill not shown by default
|
||||
metadata:
|
||||
internal: true
|
||||
---
|
||||
```
|
||||
|
||||
## Related
|
||||
|
||||
* [Skill Discovery](/tools/vercel-labs-skills/skill-discovery.md) — How skills are discovered in repos
|
||||
* [Commands](/tools/vercel-labs-skills/commands.md) — `skills init` to create new skills
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
type: reference
|
||||
title: Skills CLI Source Formats
|
||||
description: All accepted source formats for skills add and use — GitHub shorthand, full URLs, GitLab, git URLs, local paths.
|
||||
tags:
|
||||
- unverified
|
||||
- skills
|
||||
- sources
|
||||
- git
|
||||
timestamp: 2026-07-18
|
||||
verified: 2026-08-28
|
||||
---
|
||||
|
||||
# Source Formats
|
||||
|
||||
The `skills` CLI accepts multiple source formats for the `add` and `use` commands:
|
||||
|
||||
```bash
|
||||
# GitHub shorthand (owner/repo)
|
||||
npx skills add vercel-labs/agent-skills
|
||||
|
||||
# Full GitHub URL
|
||||
npx skills add https://github.com/vercel-labs/agent-skills
|
||||
|
||||
# Direct path to a skill in a repo
|
||||
npx skills add https://github.com/vercel-labs/agent-skills/tree/main/skills/web-design-guidelines
|
||||
|
||||
# GitLab URL
|
||||
npx skills add https://gitlab.com/org/repo
|
||||
|
||||
# Any git URL
|
||||
npx skills add git@github.com:vercel-labs/agent-skills.git
|
||||
|
||||
# Local path
|
||||
npx skills add ./my-local-skills
|
||||
```
|
||||
|
||||
The source parser (`src/source-parser.ts`) handles all these formats, cloning repos as needed and resolving skill directories.
|
||||
|
||||
## Related
|
||||
|
||||
* [Commands](/tools/vercel-labs-skills/commands.md) — add and use commands
|
||||
* [Skill Discovery](/tools/vercel-labs-skills/skill-discovery.md) — How skills are found within repos
|
||||
Reference in new issue
Block a user