@skill-book/cli 0.1.0
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 +73 -0
- package/dist/index.mjs +9072 -0
- package/package.json +32 -0
package/README.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# @skill-book/cli
|
|
2
|
+
|
|
3
|
+
Command-line client for **skill-book**, the internal registry for Claude Skills,
|
|
4
|
+
`CLAUDE.md`, and `AGENTS.md` files.
|
|
5
|
+
|
|
6
|
+
The package is published publicly so it can be fetched with a single command, but
|
|
7
|
+
**every operation is gated behind authentication and authorization at the API**.
|
|
8
|
+
Downloading the CLI grants nothing on its own — `push`, `install`, `search`, and
|
|
9
|
+
the rest only work once you have signed in, and you only ever see what your
|
|
10
|
+
account is permitted to see.
|
|
11
|
+
|
|
12
|
+
## Install
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm install -g @skill-book/cli
|
|
16
|
+
# or run ad hoc without installing:
|
|
17
|
+
npx @skill-book/cli <command>
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Sign in
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
skill-book login # browser-based sign-in (Google SSO / email + password)
|
|
24
|
+
skill-book login --password # non-interactive (SKILL_BOOK_EMAIL + SKILL_BOOK_PASSWORD)
|
|
25
|
+
skill-book whoami
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Common commands
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
skill-book search [query] [--type CLAUDE_SKILL|CLAUDE_MD|AGENTS_MD] [--tag <tag>] [--json]
|
|
32
|
+
skill-book info <name> [--json]
|
|
33
|
+
skill-book install <name>[@version|@latest] [--global] [--dest <path>] [--force] [--dry-run]
|
|
34
|
+
skill-book push [path] [--name <slug>] [--type <type>] [--tag <tag>...] [--dry-run] [--yes]
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
`search`, `list`, `info`, and `whoami` accept `--json` for scripting.
|
|
38
|
+
|
|
39
|
+
`push --dry-run` prints the inferred name/type and the exact file list **without
|
|
40
|
+
uploading anything** — use it to confirm a publish before it happens (versions are
|
|
41
|
+
immutable). On a TTY, `push` also asks for confirmation unless you pass `--yes`.
|
|
42
|
+
|
|
43
|
+
A Claude Skill is a directory containing a `SKILL.md` at its root. The minimal form:
|
|
44
|
+
|
|
45
|
+
```markdown
|
|
46
|
+
---
|
|
47
|
+
name: my-skill
|
|
48
|
+
description: One line describing what the skill does.
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
# My Skill
|
|
52
|
+
|
|
53
|
+
Instructions for the skill go here.
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
`install` writes only to the explicit target (a Claude Skill goes to
|
|
57
|
+
`~/.claude/skills/<name>/`, a `CLAUDE.md`/`AGENTS.md` to the current directory or,
|
|
58
|
+
with `--global`, to `~/.claude/`). It refuses to overwrite existing files unless
|
|
59
|
+
you pass `--force`, and `--dry-run` shows the plan without touching disk.
|
|
60
|
+
|
|
61
|
+
## Configuration
|
|
62
|
+
|
|
63
|
+
| Variable | Purpose |
|
|
64
|
+
| --- | --- |
|
|
65
|
+
| `SKILL_BOOK_API_URL` | Registry API base URL. Overrides the built-in default. |
|
|
66
|
+
| `SKILL_BOOK_BYPASS_TOKEN` | Pre-issued bearer token (CI / automated checks). |
|
|
67
|
+
| `SKILL_BOOK_EMAIL` / `SKILL_BOOK_PASSWORD` | Credentials for `login --password`. |
|
|
68
|
+
|
|
69
|
+
> **Pointing the CLI at your own deployment.** The published build ships with the
|
|
70
|
+
> shared dev endpoint as its default. For a separate (e.g. company production)
|
|
71
|
+
> registry, set `SKILL_BOOK_API_URL` — do not rely on the baked-in default. A
|
|
72
|
+
> future release may drop the hard-coded URL entirely in favour of explicit
|
|
73
|
+
> configuration so the public package never carries an internal endpoint.
|