Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ askill add <slug> [options]
| `-a, --agent <agents...>` | Install to specific agents only |
| `-y, --yes` | Skip confirmation prompts (non-interactive mode) |
| `--copy` | Copy files instead of symlink |
| `--skill <name>` | Install one skill from a multi-skill source without prompting |
| `--json` | Output machine-readable JSON |

### Examples
Expand All @@ -78,6 +79,9 @@ askill add gh:facebook/react/scripts/error-codes
# List skills in a repo and select
askill add gh:facebook/react

# Install one skill from a local multi-skill directory
askill add ./skills --skill formatter -a opencode -y --json

# Install globally
askill add gh:owner/repo@skill -g

Expand Down
12 changes: 10 additions & 2 deletions docs/integrating-askill-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,12 @@ askill add owner/repo@skill-name -g -a opencode -y --json

# install all discovered skills
askill add ./skills --all -a opencode -y --json

# install one selected skill from a local multi-skill source
askill add ./skills --skill skill-name -a opencode -y --json

# link an already-installed canonical skill to another agent
askill add .agents/skills/skill-name -a codex -y --json
```

Typical fields:
Expand All @@ -167,6 +173,8 @@ Typical fields:
- `summary` (`operations`, `successful`, `failed`, `skills`, `dependencies`)
- `results[]` (per skill + per agent)

For GitHub sources, `owner/repo@skill-name` remains the compact non-interactive selector. For local directories, use `--skill <name>` so paths containing `@` stay unambiguous. Re-linking from `.agents/skills/<name>` is idempotent and preserves the existing lock source metadata.

### Check update status

```bash
Expand All @@ -182,7 +190,7 @@ Typical fields:
- `scope` (`project` | `global`)
- `requestedSkill`
- `summary` (`total`, `updateAvailable`, `upToDate`, `uncheckable`)
- `skills[]` with `status` (`update_available` | `up_to_date` | `uncheckable`), source metadata, hashes, and `reason`
- `skills[]` with `status` (`update_available` | `up_to_date` | `uncheckable`), source metadata, hashes or versions, and `reason`

### Update skills

Expand All @@ -200,7 +208,7 @@ Typical fields:
- `targetAgents[]`
- `check.summary`
- `summary` (`checked`, `updateAvailable`, `updated`, `skipped`, `failed`)
- `results[]` with `status` (`updated` | `skipped` | `failed`), `checkStatus`, `reason`, `error`, source metadata, hashes, and agents
- `results[]` with `status` (`updated` | `skipped` | `failed`), `checkStatus`, `reason`, `error`, source metadata, hashes or versions, and agents

### Remove skills

Expand Down
8 changes: 6 additions & 2 deletions docs/json-contracts/askill-cli-json.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@
},
"CheckSkillItem": {
"type": "object",
"required": ["name", "scope", "status", "source", "sourceType", "sourceUrl", "skillPath", "localHash", "remoteHash", "reason", "installedAt", "updatedAt"],
"required": ["name", "scope", "status", "source", "sourceType", "sourceUrl", "skillPath", "localHash", "remoteHash", "localVersion", "remoteVersion", "reason", "installedAt", "updatedAt"],
"properties": {
"name": { "type": "string" },
"scope": { "type": "string", "enum": ["project", "global"] },
Expand All @@ -311,6 +311,8 @@
"skillPath": { "type": ["string", "null"] },
"localHash": { "type": ["string", "null"] },
"remoteHash": { "type": ["string", "null"] },
"localVersion": { "type": ["string", "null"] },
"remoteVersion": { "type": ["string", "null"] },
"reason": { "type": ["string", "null"] },
"installedAt": { "type": ["string", "null"] },
"updatedAt": { "type": ["string", "null"] }
Expand All @@ -332,7 +334,7 @@
},
"UpdateResultItem": {
"type": "object",
"required": ["skill", "status", "success", "checkStatus", "reason", "error", "source", "sourceUrl", "skillPath", "localHash", "remoteHash", "agents"],
"required": ["skill", "status", "success", "checkStatus", "reason", "error", "source", "sourceUrl", "skillPath", "localHash", "remoteHash", "localVersion", "remoteVersion", "agents"],
"properties": {
"skill": { "type": "string" },
"status": { "type": "string", "enum": ["updated", "skipped", "failed"] },
Expand All @@ -345,6 +347,8 @@
"skillPath": { "type": ["string", "null"] },
"localHash": { "type": ["string", "null"] },
"remoteHash": { "type": ["string", "null"] },
"localVersion": { "type": ["string", "null"] },
"remoteVersion": { "type": ["string", "null"] },
"agents": { "type": "array", "items": { "$ref": "#/$defs/AgentRef" } }
},
"additionalProperties": true
Expand Down
Loading
Loading