Skip to content

Commit eb022b6

Browse files
committed
docs: update CLI README and docs page with new identifier formats
1 parent 8b4eaf7 commit eb022b6

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

apps/web/app/routes/docs.tsx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,12 @@ export default function Docs() {
9191

9292
<CommandEntry
9393
icon={<Terminal size={18} />}
94-
name="skillx use <slug>"
95-
description="View full details of a skill including description, rating, install command, and content preview."
96-
example="skillx use better-auth"
94+
name="skillx use <identifier>"
95+
description="Smart skill lookup — supports author/skill, org/repo/skill, slug, or keyword search. Auto-registers from GitHub if not found."
96+
example="skillx use alinaqi/code-review"
9797
flags={[
9898
{ flag: "-r, --raw", desc: "Output raw content only (for piping to files)" },
99+
{ flag: "-s, --search", desc: "Force search mode regardless of identifier format" },
99100
]}
100101
/>
101102

packages/cli/README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,23 @@ skillx find "testing"
3838

3939
### `skillx use <identifier>`
4040

41-
Smart skill lookup — auto-detects whether you're using a slug, GitHub repo, or keyword search.
41+
Smart skill lookup — supports multiple identifier formats:
4242

4343
```bash
44-
skillx use owner/repo # direct lookup, auto-registers from GitHub if new
45-
skillx use "ui ux design" # keyword search, auto-picks top result
46-
skillx use my-skill # exact slug lookup (fallback to search on 404)
47-
skillx use my-skill --raw # output raw content (for piping)
44+
skillx use author/skill-name # direct lookup by author and skill name
45+
skillx use org/repo/skill-name # lookup or auto-register from GitHub repo subfolder
46+
skillx use org/repo # scan GitHub repo for all skills (discovers SKILL.md files)
47+
skillx use slug # exact slug lookup (fallback to search on 404)
48+
skillx use "keyword query" # search and auto-pick top result
49+
skillx use author/skill-name --raw # output raw content (for piping)
50+
skillx use something --search # force search mode
4851
```
4952

5053
**How it works:**
51-
- `org/repo` format → fetches directly, auto-registers + indexes in Vectorize if not in DB
52-
- Multi-word query → searches and uses the top result
53-
- Single-word slug → tries direct lookup, falls back to search if not found
54+
- `author/skill` (two-part) → DB lookup by slug `author-skill`, fallback scan repo
55+
- `org/repo/skill` (three-part) → DB lookup `org-skill`, fallback register from GitHub subfolder
56+
- Single word → direct slug lookup, falls back to search if not found
57+
- Multi-word or `--search` flag → searches and uses the top result
5458

5559
### `skillx report <slug> <outcome>`
5660

0 commit comments

Comments
 (0)