skillship 1.0.1 → 1.0.2
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.
- package/README.md +20 -17
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -16,11 +16,29 @@ registry. It adds the three things the ecosystem is missing:
|
|
|
16
16
|
|
|
17
17
|
## Install / usage
|
|
18
18
|
|
|
19
|
+
Both commands below use `npx`, which ships with [Node.js](https://nodejs.org)
|
|
20
|
+
(>= 18). If `npx` is not found, install Node.js first — e.g. download the LTS
|
|
21
|
+
installer from [nodejs.org](https://nodejs.org), or use a version manager
|
|
22
|
+
(`brew install node`, `nvm install --lts`, `winget install OpenJS.NodeJS.LTS`).
|
|
23
|
+
Verify with `node -v` and `npx -v`.
|
|
24
|
+
|
|
25
|
+
**Recommended:** install the bundled `/skillship` Agent Skill straight from
|
|
26
|
+
GitHub. It drives the CLI for you — invoke `/skillship` (or ask to publish a
|
|
27
|
+
skill) and the agent locates/scaffolds a `SKILL.md`, validates it, fixes issues,
|
|
28
|
+
and installs or packages it for the chosen surface:
|
|
29
|
+
|
|
19
30
|
```bash
|
|
20
|
-
npx skillship
|
|
31
|
+
npx skills add shivdeepak/skillship
|
|
21
32
|
```
|
|
22
33
|
|
|
23
|
-
|
|
34
|
+
Add `-a <agent>` (e.g. `-a cursor`, repeatable) to target specific agents, or
|
|
35
|
+
`-g` to install globally.
|
|
36
|
+
|
|
37
|
+
Or run the CLI directly with `npx` (requires Node.js >= 18):
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npx skillship <command>
|
|
41
|
+
```
|
|
24
42
|
|
|
25
43
|
## Commands
|
|
26
44
|
|
|
@@ -127,21 +145,6 @@ metadata:
|
|
|
127
145
|
Checks the local environment: Node >= 18 and `npx` (required), plus `gh` and
|
|
128
146
|
`agentskills` (optional).
|
|
129
147
|
|
|
130
|
-
## Bundled skill (`/skillship`)
|
|
131
|
-
|
|
132
|
-
skillship ships with its own Agent Skill at `skillship/SKILL.md`. Installed into
|
|
133
|
-
any agent, it drives the CLI for you: invoke `/skillship` (or ask to publish a
|
|
134
|
-
skill) and the agent locates/scaffolds the `SKILL.md`, validates it, fixes
|
|
135
|
-
issues, and installs or packages it for the chosen surface.
|
|
136
|
-
|
|
137
|
-
Install it like any other skill, into whichever agents you use:
|
|
138
|
-
|
|
139
|
-
```bash
|
|
140
|
-
npx skills add ./skillship -a cursor,claude-code [--global]
|
|
141
|
-
# or, dogfooding skillship itself:
|
|
142
|
-
npx skillship install ./skillship -a cursor,claude-code
|
|
143
|
-
```
|
|
144
|
-
|
|
145
148
|
## Development
|
|
146
149
|
|
|
147
150
|
```bash
|