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
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,12 +90,16 @@ Enables `add`, `update`, `remove`, `validate`, `search`, `show`, and `doc` (gene
# Add a sample skill
skillport add hello-world

# Or add from GitHub
# Or add from GitHub (shorthand format)
skillport add anthropics/skills skills # specific path
skillport add anthropics/skills skills examples # multiple paths (1 download)

# Or add from GitHub (full URL)
skillport add https://github.com/anthropics/skills/tree/main/skills

# Or add from GitHub with custom skills directory (Claude Code, Codex)
skillport --skills-dir .claude/skills add https://github.com/anthropics/skills/tree/main/skills
skillport --skills-dir ~/.codex/skills add https://github.com/anthropics/skills/tree/main/skills/frontend-design
# With custom skills directory (Claude Code, Codex)
skillport --skills-dir .claude/skills add anthropics/skills skills
skillport --skills-dir ~/.codex/skills add anthropics/skills skills/frontend-design
```

### 3. Add to Your MCP Client
Expand Down Expand Up @@ -199,7 +203,8 @@ skillport init

# 3. Add skills (uses skills_dir from .skillportrc)
skillport add hello-world
skillport add https://github.com/anthropics/skills/tree/main/skills
skillport add anthropics/skills skills # shorthand format
skillport add anthropics/skills skills examples # multiple paths
skillport add https://github.com/anthropics/skills/tree/main/skills/frontend-design
```

Expand Down Expand Up @@ -257,18 +262,21 @@ skillport show <id> # View skill details and instructions

**Install from GitHub:**

One command to install skills from any GitHub URL-no cloning required. Supports branches and subdirectories:
One command to install skills from any GitHub URL-no cloning required. Supports shorthand format, branches, and subdirectories:

```bash
# Anthropic official skills
skillport add https://github.com/anthropics/skills/tree/main/skills
# Shorthand format (owner/repo [paths...])
skillport add anthropics/skills skills # specific path
skillport add anthropics/skills skills examples # multiple paths (1 download)
skillport add owner/repo # repo root

# Specific path in a repo
# Full URL format
skillport add https://github.com/anthropics/skills/tree/main/skills
skillport add https://github.com/wshobson/agents/tree/main/plugins/developer-essentials/skills

# Private repos work automatically if you use GitHub CLI
gh auth login # one-time setup
skillport add https://github.com/your-org/private-skills
skillport add your-org/private-skills skills
```

**Discover more:**
Expand Down
26 changes: 23 additions & 3 deletions guide/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,14 +146,21 @@ skillport add <source> [options]
| Local | `./my-collection/` | Directory containing multiple skills |
| Local | `./mixed/` | Directory containing both skill directories and zip files |
| Zip | `./my-skill.zip` | Single skill in zip format (1 zip = 1 skill) |
| GitHub | `https://github.com/user/repo` | Repository root (auto-detects default branch) |
| GitHub | `https://github.com/user/repo/tree/main/skills` | Specific directory |
| GitHub | `user/repo` | Shorthand format (auto-detects default branch) |
| GitHub | `user/repo skills` | Shorthand with path(s) - single download, multiple paths |
| GitHub | `https://github.com/user/repo` | Full URL (auto-detects default branch) |
| GitHub | `https://github.com/user/repo/tree/main/skills` | Full URL with specific directory |

> **Zip file support**:
> - Each zip file must contain exactly one skill
> - Zip files in a directory are automatically detected and extracted
> - Useful for skills exported from Claude.ai

> **GitHub shorthand** (`owner/repo`):
> - Simpler syntax: `skillport add anthropics/skills`
> - Supports multiple paths: `skillport add owner/repo skills examples` (single download)
> - Local paths take priority (if `./owner/repo` exists, it's treated as local)

> **GitHub URL support**:
> - Works with or without trailing slash
> - Auto-detects default branch when not specified
Expand Down Expand Up @@ -243,7 +250,20 @@ skillport add ./my-skill.zip --namespace my-ns
# → skills/my-ns/my-skill/
```

**GitHub:**
**GitHub (shorthand):**
```bash
# All skills from repository root
skillport add anthropics/skills

# Specific path(s) within repository - single download, efficient
skillport add anthropics/skills skills
skillport add owner/repo skills examples # multiple paths

# Force overwrite existing
skillport add anthropics/skills --force
```

**GitHub (full URL):**
```bash
# Specific skill from repository
skillport add https://github.com/user/repo/tree/main/skills/code-review
Expand Down
Loading