Files
openclaw/docs/skills.md

149 lines
5.5 KiB
Markdown
Raw Normal View History

2025-12-20 12:22:15 +01:00
---
summary: "Skills: managed vs workspace, gating rules, and config/env wiring"
read_when:
- Adding or modifying skills
- Changing skill gating or load rules
---
<!-- {% raw %} -->
# Skills (Clawdis)
2025-12-20 12:23:53 +00:00
Clawdis uses **AgentSkills-compatible** skill folders to teach the agent how to use tools. Each skill is a directory containing a `SKILL.md` with YAML frontmatter and instructions. Clawdis loads **bundled skills** plus optional local overrides, and filters them at load time based on environment, config, and binary presence.
2025-12-20 12:22:15 +01:00
## Locations and precedence
2025-12-20 12:23:53 +00:00
Skills are loaded from **three** places:
2025-12-20 12:22:15 +01:00
2025-12-20 12:23:53 +00:00
1) **Bundled skills**: shipped with the install (npm package or Clawdis.app)
2) **Managed/local skills**: `~/.clawdis/skills`
3) **Workspace skills**: `<workspace>/skills`
2025-12-20 12:22:15 +01:00
2025-12-20 12:23:53 +00:00
If a skill name conflicts, precedence is:
`<workspace>/skills` (highest) → `~/.clawdis/skills` → bundled skills (lowest)
2025-12-20 12:22:15 +01:00
2026-01-01 10:07:31 +01:00
Additionally, you can configure extra skill folders (lowest precedence) via
`skills.load.extraDirs` in `~/.clawdis/clawdis.json`.
2025-12-20 12:26:58 +00:00
2025-12-20 12:22:15 +01:00
## Format (AgentSkills + Pi-compatible)
`SKILL.md` must include at least:
```markdown
---
name: nano-banana-pro
description: Generate or edit images via Gemini 3 Pro Image
---
```
Notes:
- We follow the AgentSkills spec for layout/intent.
- The parser used by the embedded agent supports **single-line** frontmatter keys only.
- `metadata` should be a **single-line JSON object**.
- Use `{baseDir}` in instructions to reference the skill folder path.
2025-12-20 17:31:09 +01:00
- Optional frontmatter keys:
- `homepage` — URL surfaced as “Website” in the macOS Skills UI (also supported via `metadata.clawdis.homepage`).
2025-12-20 12:22:15 +01:00
## Gating (load-time filters)
Clawdis **filters skills at load time** using `metadata` (single-line JSON):
```markdown
---
name: nano-banana-pro
description: Generate or edit images via Gemini 3 Pro Image
metadata: {"clawdis":{"requires":{"bins":["uv"],"env":["GEMINI_API_KEY"],"config":["browser.enabled"]},"primaryEnv":"GEMINI_API_KEY"}}
---
```
Fields under `metadata.clawdis`:
- `always: true` — always include the skill (skip other gates).
- `emoji` — optional emoji used by the macOS Skills UI.
2025-12-20 17:31:09 +01:00
- `homepage` — optional URL shown as “Website” in the macOS Skills UI.
2026-01-01 22:23:23 +01:00
- `os` — optional list of platforms (`darwin`, `linux`, `win32`). If set, the skill is only eligible on those OSes.
2025-12-20 12:22:15 +01:00
- `requires.bins` — list; each must exist on `PATH`.
- `requires.env` — list; env var must exist **or** be provided in config.
- `requires.config` — list of `clawdis.json` paths that must be truthy.
2026-01-01 10:07:31 +01:00
- `primaryEnv` — env var name associated with `skills.entries.<name>.apiKey`.
2025-12-20 17:50:29 +01:00
- `install` — optional array of installer specs used by the macOS Skills UI (brew/node/go/uv).
Installer example:
```markdown
---
name: gemini
description: Use Gemini CLI for coding assistance and Google search lookups.
metadata: {"clawdis":{"emoji":"♊️","requires":{"bins":["gemini"]},"install":[{"id":"brew","kind":"brew","formula":"gemini-cli","bins":["gemini"],"label":"Install Gemini CLI (brew)"}]}}
---
```
2025-12-20 12:22:15 +01:00
Notes:
- If multiple installers are listed, the gateway picks a **single** preferred option (brew when available, otherwise node).
2026-01-01 17:57:57 +01:00
- Node installs honor `skills.install.nodeManager` in `clawdis.json` (default: npm; options: npm/pnpm/yarn/bun).
2026-01-01 22:23:23 +01:00
- Go installs: if `go` is missing and `brew` is available, the gateway installs Go via Homebrew first and sets `GOBIN` to Homebrews `bin` when possible.
2026-01-01 10:07:31 +01:00
If no `metadata.clawdis` is present, the skill is always eligible (unless
disabled in config or blocked by `skills.allowBundled` for bundled skills).
2025-12-20 12:22:15 +01:00
## Config overrides (`~/.clawdis/clawdis.json`)
2025-12-20 12:23:53 +00:00
Bundled/managed skills can be toggled and supplied with env values:
2025-12-20 12:22:15 +01:00
```json5
{
skills: {
2026-01-01 10:07:31 +01:00
entries: {
"nano-banana-pro": {
enabled: true,
apiKey: "GEMINI_KEY_HERE",
env: {
GEMINI_API_KEY: "GEMINI_KEY_HERE"
}
},
peekaboo: { enabled: true },
sag: { enabled: false }
}
2025-12-20 12:22:15 +01:00
}
}
```
Note: if the skill name contains hyphens, quote the key (JSON5 allows quoted keys).
2026-01-01 10:07:31 +01:00
Config keys match the **skill name** by default. If a skill defines
`metadata.clawdis.skillKey`, use that key under `skills.entries`.
2025-12-20 12:22:15 +01:00
Rules:
2025-12-20 12:23:53 +00:00
- `enabled: false` disables the skill even if its bundled/installed.
2025-12-20 12:22:15 +01:00
- `env`: injected **only if** the variable isnt already set in the process.
- `apiKey`: convenience for skills that declare `metadata.clawdis.primaryEnv`.
2026-01-01 10:07:31 +01:00
- `allowBundled`: optional allowlist for **bundled** skills only. If set, only
bundled skills in the list are eligible (managed/workspace skills unaffected).
2025-12-20 12:22:15 +01:00
## Environment injection (per agent run)
When an agent run starts, Clawdis:
1) Reads skill metadata.
2026-01-01 10:07:31 +01:00
2) Applies any `skills.entries.<key>.env` or `skills.entries.<key>.apiKey` to
`process.env`.
2025-12-20 12:22:15 +01:00
3) Builds the system prompt with **eligible** skills.
4) Restores the original environment after the run ends.
This is **scoped to the agent run**, not a global shell environment.
## Session snapshot (performance)
Clawdis snapshots the eligible skills **when a session starts** and reuses that list for subsequent turns in the same session. Changes to skills or config take effect on the next new session.
## Managed skills lifecycle
2026-01-01 10:07:31 +01:00
Clawdis ships a baseline set of skills as **bundled skills** as part of the
install (npm package or Clawdis.app). `~/.clawdis/skills` exists for local
overrides (for example, pinning/patching a skill without changing the bundled
copy). Workspace skills are user-owned and override both on name conflicts.
## Config reference
See `docs/skills-config.md` for the full configuration schema.
2025-12-20 12:22:15 +01:00
---
<!-- {% endraw %} -->