@localskills/cli 0.1.0 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +148 -0
  2. package/dist/index.js +725 -242
  3. package/package.json +1 -1
package/README.md ADDED
@@ -0,0 +1,148 @@
1
+ # @localskills/cli
2
+
3
+ CLI for [localskills.sh](https://localskills.sh) — install, manage, and publish agent skills for AI coding tools.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ npm install -g @localskills/cli
9
+ ```
10
+
11
+ ## Supported platforms
12
+
13
+ | Platform | ID | Global | Project | Method |
14
+ |---|---|---|---|---|
15
+ | Cursor | `cursor` | `~/.cursor/rules/` | `.cursor/rules/` | symlink |
16
+ | Claude Code | `claude` | `~/.claude/skills/` | `.claude/skills/` | symlink |
17
+ | Windsurf | `windsurf` | `~/.codeium/windsurf/memories/` | `.windsurf/rules/` | section (global), symlink (project) |
18
+ | Cline | `cline` | — | `.clinerules/` | symlink |
19
+ | GitHub Copilot | `copilot` | — | `.github/copilot-instructions.md` | section |
20
+ | Codex CLI | `codex` | `~/.codex/AGENTS.md` | `./AGENTS.md` | section |
21
+ | OpenCode | `opencode` | `~/.config/opencode/rules/` | `.opencode/rules/` | symlink |
22
+ | Aider | `aider` | — | `.aider/skills/` | symlink |
23
+
24
+ The CLI auto-detects which platforms are installed and pre-selects them during interactive flows.
25
+
26
+ ## Commands
27
+
28
+ ### `localskills login`
29
+
30
+ Authenticate with localskills.sh by pasting your API token.
31
+
32
+ ```bash
33
+ localskills login
34
+ ```
35
+
36
+ ### `localskills logout`
37
+
38
+ Clear stored credentials.
39
+
40
+ ### `localskills whoami`
41
+
42
+ Show the current authenticated user.
43
+
44
+ ### `localskills install [slug]`
45
+
46
+ Install a skill to one or more platforms. Without a slug, launches an interactive picker.
47
+
48
+ ```bash
49
+ # Interactive — prompts for skill, platforms, scope, and method
50
+ localskills install
51
+
52
+ # Direct — skip prompts
53
+ localskills install my-skill -t cursor,claude -g --symlink
54
+ ```
55
+
56
+ **Options:**
57
+
58
+ | Flag | Description |
59
+ |---|---|
60
+ | `-t, --target <targets...>` | Target platforms (comma-separated) |
61
+ | `-g, --global` | Install globally (home directory) |
62
+ | `-p, --project [dir]` | Install in project directory |
63
+ | `--symlink` | Symlink from cache (default) |
64
+ | `--copy` | Copy file instead of symlinking |
65
+
66
+ ### `localskills uninstall [slug]`
67
+
68
+ Remove an installed skill from all platforms. Without a slug, launches an interactive picker.
69
+
70
+ ```bash
71
+ localskills uninstall my-skill --purge
72
+ ```
73
+
74
+ **Options:**
75
+
76
+ | Flag | Description |
77
+ |---|---|
78
+ | `--purge` | Also remove from local cache |
79
+
80
+ ### `localskills pull [slug]`
81
+
82
+ Update installed skills by fetching the latest content from localskills.sh. Without a slug, updates all installed skills.
83
+
84
+ ```bash
85
+ # Update everything
86
+ localskills pull
87
+
88
+ # Update one skill
89
+ localskills pull my-skill
90
+ ```
91
+
92
+ Symlinked installations update automatically when the cache is refreshed. Copied and section-based installations are re-written in place.
93
+
94
+ ### `localskills list`
95
+
96
+ List available skills from localskills.sh.
97
+
98
+ ```bash
99
+ localskills list
100
+ localskills list --public
101
+ ```
102
+
103
+ ### `localskills publish [file]`
104
+
105
+ Publish a local skill file to localskills.sh. Without a file argument, scans your project for unpublished skill files across all supported platform directories.
106
+
107
+ ```bash
108
+ # Scan and publish interactively
109
+ localskills publish
110
+
111
+ # Publish a specific file
112
+ localskills publish .cursor/rules/my-skill.mdc -n "My Skill" --visibility public
113
+ ```
114
+
115
+ **Options:**
116
+
117
+ | Flag | Description |
118
+ |---|---|
119
+ | `-t, --team <id>` | Team ID or slug |
120
+ | `-n, --name <name>` | Skill name |
121
+ | `--visibility <level>` | `private`, `public`, or `unlisted` (default: `private`) |
122
+ | `-m, --message <message>` | Version message |
123
+
124
+ ## Installation methods
125
+
126
+ - **Symlink** (default) — links the skill file from `~/.localskills/cache/` to the target location. Updates propagate automatically via `localskills pull`.
127
+ - **Copy** — writes a standalone copy. Independent of cache but requires re-install to update.
128
+ - **Section** — for single-file platforms (Copilot, Codex, Windsurf global), injects the skill into a shared file between `<!-- localskills:start:slug -->` / `<!-- localskills:end:slug -->` markers.
129
+
130
+ ## Configuration
131
+
132
+ Config and cache are stored at `~/.localskills/`:
133
+
134
+ ```
135
+ ~/.localskills/
136
+ config.json # Auth token, installed skills, preferences
137
+ cache/
138
+ my-skill/
139
+ raw.md # Original content
140
+ meta.json # Hash, version, metadata
141
+ cursor.mdc # Platform-specific transformed files
142
+ claude/
143
+ SKILL.md
144
+ ```
145
+
146
+ ## License
147
+
148
+ MIT