Skip to content

Commit 84e2817

Browse files
committed
feat: add sm as shorthand binary alias for skills-manager
1 parent b5824f6 commit 84e2817

2 files changed

Lines changed: 21 additions & 20 deletions

File tree

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -36,65 +36,65 @@ npx @tc9011/skills-manager push
3636
npm install -g @tc9011/skills-manager
3737
```
3838

39-
> **Tip:** If installed globally, you can use `skills-manager` instead of `npx @tc9011/skills-manager` in all commands below.
39+
> **Tip:** After global install, use `sm` (or the full name `skills-manager`) instead of `npx @tc9011/skills-manager` in all commands below.
4040
4141
**Requirements:** Node.js ≥ 20, [GitHub CLI](https://cli.github.com/) (`gh`) recommended for auth.
4242

4343
## Quick Start
4444

4545
```bash
4646
# 1. Backup skills to GitHub
47-
skills-manager push
47+
sm push
4848

4949
# 2. Restore on a new machine
50-
skills-manager pull --repo owner/my-skills
50+
sm pull --repo owner/my-skills
5151

5252
# 3. Re-link skills to agents (auto-runs after pull)
53-
skills-manager link
53+
sm link
5454

5555
# 4. Link skills to current project directory
56-
skills-manager link --project
56+
sm link --project
5757
```
5858

5959
On first run, `push` and `pull` will interactively set up a git repo and remote if `~/.agents/` isn't already one.
6060

6161
## Commands
6262

63-
### `skills-manager push`
63+
### `sm push`
6464

6565
Commits and pushes `~/.agents/` to its configured GitHub remote.
6666

6767
```bash
68-
skills-manager push
69-
skills-manager push -m "add new debugging skill"
68+
sm push
69+
sm push -m "add new debugging skill"
7070
```
7171

7272
| Option | Description |
7373
|--------|-------------|
7474
| `-m, --message <msg>` | Custom commit message (default: auto-generated) |
7575

76-
### `skills-manager pull`
76+
### `sm pull`
7777

7878
Pulls from GitHub and automatically runs `link`.
7979

8080
```bash
81-
skills-manager pull --repo tc9011/my-skills
82-
skills-manager pull # uses existing remote
83-
skills-manager pull --skip-link # pull only, don't link
81+
sm pull --repo tc9011/my-skills
82+
sm pull # uses existing remote
83+
sm pull --skip-link # pull only, don't link
8484
```
8585

8686
| Option | Description |
8787
|--------|-------------|
8888
| `-r, --repo <owner/name>` | GitHub repo to pull from |
8989
| `--skip-link` | Skip automatic agent linking after pull |
9090

91-
### `skills-manager link`
91+
### `sm link`
9292

9393
Reads `.skill-lock.json` and creates relative symlinks from each agent's skills directory to the canonical `~/.agents/skills/`.
9494

9595
```bash
96-
skills-manager link
97-
skills-manager link --agents cursor opencode claude-code
96+
sm link
97+
sm link --agents cursor opencode claude-code
9898
```
9999

100100
| Option | Description |
@@ -109,7 +109,7 @@ When `--agents` is provided, the agent selection prompt is skipped entirely —
109109

110110
```bash
111111
# Non-interactive: link all skills to specific agents
112-
skills-manager link --agents cursor opencode
112+
sm link --agents cursor opencode
113113
```
114114

115115
**Symlink model:**
@@ -131,7 +131,7 @@ All three prompts can be skipped by providing `--skills`, `--mode`, and `--agent
131131

132132
```bash
133133
# Fully non-interactive project link
134-
skills-manager link --project --agents cursor claude-code --skills my-skill --mode copy
134+
sm link --project --agents cursor claude-code --skills my-skill --mode copy
135135
```
136136
Example project structure after `link --project`:
137137
```
@@ -238,15 +238,15 @@ If none are found, git will attempt the operation unauthenticated — which work
238238
├── my-skill/
239239
└── another-skill/
240240
241-
skills-manager link reads .skill-lock.json → creates relative symlinks:
241+
sm link reads .skill-lock.json → creates relative symlinks:
242242
243243
~/.cursor/skills/my-skill → ../../.agents/skills/my-skill
244244
~/.claude/skills/my-skill → ../../.agents/skills/my-skill
245245
~/.config/opencode/skills/my-skill → ../../../.agents/skills/my-skill
246246
```
247247

248248
```
249-
skills-manager link --project reads .skill-lock.json → select skills → choose copy/symlink → select agents → copies/symlinks to CWD:
249+
sm link --project reads .skill-lock.json → select skills → choose copy/symlink → select agents → copies/symlinks to CWD:
250250
251251
./my-project/.agents/skills/my-skill ← copied from ~/.agents/skills/
252252
./my-project/.claude/skills/my-skill ← copied from ~/.agents/skills/

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@
2424
"vercel-skills"
2525
],
2626
"bin": {
27-
"skills-manager": "./dist/index.js"
27+
"skills-manager": "./dist/index.js",
28+
"sm": "./dist/index.js"
2829
},
2930
"files": [
3031
"dist"

0 commit comments

Comments
 (0)