@kheif/quiver 1.1.0 → 1.2.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.
Files changed (2) hide show
  1. package/README.md +53 -22
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -20,6 +20,14 @@ curl -fsSL https://raw.githubusercontent.com/kheif/quiver/main/install.sh | sh
20
20
 
21
21
  The script downloads the latest release for your system, checks its checksum and installs `quiver` into `~/.local/bin`. Set `QUIVER_VERSION=v1.0.0` for a given release, or `QUIVER_INSTALL_DIR` for another folder. Run it again to update.
22
22
 
23
+ **Windows (PowerShell):**
24
+
25
+ ```powershell
26
+ irm https://raw.githubusercontent.com/kheif/quiver/main/install.ps1 | iex
27
+ ```
28
+
29
+ The same steps for Windows: it installs `quiver.exe` into `%LOCALAPPDATA%\Programs\quiver` and adds that folder to your user `PATH`, without admin rights; open a new terminal afterwards. `QUIVER_VERSION` and `QUIVER_INSTALL_DIR` work the same way, set with `$env:QUIVER_INSTALL_DIR = '...'` before the line.
30
+
23
31
  **npm (macOS, Linux and Windows):**
24
32
 
25
33
  ```sh
@@ -36,25 +44,27 @@ go install github.com/kheif/quiver/cmd/quiver@latest
36
44
 
37
45
  The archives for every platform are also on the [releases page](https://github.com/kheif/quiver/releases). To build from a clone: `make build`, which writes `bin/quiver`.
38
46
 
47
+ **New versions.** Once a day, a command run in a terminal asks GitHub for the latest release, while it runs, and remembers the answer in `~/.quiver/state/version-check.json`. When a newer version is out, the command ends with one line on stderr, with the install command that matches how you installed Quiver. Nothing is shown for `quiver mcp`, with `--json`, outside a terminal or for development builds, and a failed check is silent. `quiver doctor` shows the latest version. Set `QUIVER_NO_UPDATE_CHECK=1` to turn the check off.
48
+
39
49
  ## Quickstart
40
50
 
41
51
  ```sh
42
- # 1. Create the library in ~/.quiver (any other command does this too)
52
+ # 1. Create the library in ~/.quiver, register the MCP server with your
53
+ # assistants and import the skills you already have
43
54
  quiver init
44
55
 
45
- # 2. Register the MCP server with Claude Code, once for all projects
46
- quiver mcp install
47
-
48
- # 3. In a project folder, write a skill for that project
56
+ # 2. In a project folder, write a skill for that project
49
57
  cd ~/code/app
50
58
  quiver new release-notes
51
59
  ```
52
60
 
61
+ In a terminal, `quiver init` asks before each step: registering the MCP server (`quiver mcp install`), importing the skills in `~/.claude/skills` for every folder, and importing those in the current project's `.claude/skills`. Any step can be skipped and run later. `quiver init --yes`, or a run outside a terminal, only creates `~/.quiver`; any other command creates it too.
62
+
53
63
  `quiver new` opens the new `SKILL.md` in `$VISUAL` or `$EDITOR`. Write one sentence in `description` on when the assistant should use the skill, and the instructions below the frontmatter. Quiver commits the skill in `~/.quiver/local` and creates `~/code/app/.quiver.json`. Commit that file, so the project keeps its ID in every clone.
54
64
 
55
65
  Then start Claude Code in `~/code/app` and ask for the task, such as "write the release notes for this version". The assistant sees `release-notes` in Quiver's skill list and loads it. You can also run it yourself as `/quiver:release-notes`.
56
66
 
57
- `quiver status` shows what the assistant gets in the current folder.
67
+ `quiver status` shows what the assistant gets in the current folder. `quiver` alone sums it up in three lines, with a next step, before the command list.
58
68
 
59
69
  ## Concepts
60
70
 
@@ -63,7 +73,8 @@ Then start Claude Code in `~/code/app` and ask for the task, such as "write the
63
73
  - **Skill IDs.** A local skill's ID is its folder name, such as `release-notes`. A skill from a source is `<source>/<skill>`, such as `anthropic/pdf`.
64
74
  - **Assignments.** `registry.json` stores which skills are global and which projects get which skills. A folder that is not a project gets only the global skills.
65
75
  - **Assignments are yours.** They live in your `~/.quiver`, not in the project. A teammate who clones the project gets its `.quiver.json`, but not your skills or assignments. To share skills, put them in a git repository that everyone adds with `quiver source add`.
66
- - **Projects.** A project is the folder with `.quiver.json`, found by walking up from the current folder. It is created the first time you assign a skill there. The ID survives moves and renames. Git worktrees of one repository share the committed `.quiver.json`, so they are one project with the same skills. If a folder is copied, both copies have the same ID; `quiver status` warns, and `quiver projects split` gives the copy its own.
76
+ - **Projects.** A project is the folder with `.quiver.json`, found by walking up from the current folder. It is created the first time you assign a skill there; in a terminal, `add`, `new` and `import` first ask `Register <folder> as a project?` (`--yes` skips the question). The ID survives moves and renames. Git worktrees of one repository share the committed `.quiver.json`, so they are one project with the same skills. If a folder is copied, both copies have the same ID; `quiver status` warns, and `quiver projects split` gives the copy its own.
77
+ - **One copy of each skill.** A skill that Quiver serves and that Claude Code also loads by itself, from `~/.claude/skills`, the project's `.claude/skills` or an enabled plugin, may be loaded twice. `quiver import` therefore deletes the originals it copied, except those committed in a project's git, which teammates may still need (`--keep` keeps every original). `quiver status` and `quiver doctor` report the copies they find, by name or by content, and `quiver doctor --fix` deletes those not committed in git and not in a plugin.
67
78
  - **Always-on skills.** A skill added with `--always` is loaded before the assistant's first reply, for style or rules that apply to every answer. See the limits below.
68
79
 
69
80
  ## Commands
@@ -72,26 +83,30 @@ Run `quiver help <command>` for the details and examples of each.
72
83
 
73
84
  | Command | What it does |
74
85
  |---|---|
75
- | `quiver init` | Create the Quiver home and anything missing in it. |
86
+ | `quiver` | Show the project here, how many skills it is served and a next step, then the command list. |
87
+ | `quiver init` | Create the Quiver home and anything missing in it; in a terminal, then offer to register the MCP server and import existing skills (`--yes`: only create the home). |
76
88
  | `quiver new <name>` | Create a local skill and assign it to this project (`--global`: every folder, `--none`: nowhere). |
77
89
  | `quiver edit <id>` | Open a local skill in your editor, then check and commit it. |
78
90
  | `quiver delete <id>` | Delete a local skill from the library. An assigned skill needs `--force`. |
79
- | `quiver import` | Copy the skills in this project's `.claude/skills` into the library (`--deep`: every folder of the project). |
80
- | `quiver import <folder>` | Copy every skill in a folder and its subfolders. Files that are not valid skills are listed at the end. |
81
- | `quiver import <skill>` | Copy one skill: its `SKILL.md`, its folder or a markdown file with frontmatter. `--name` renames it. |
91
+ | `quiver import` | Move the skills in this project's `.claude/skills` into the library (`--deep`: every folder of the project). Originals committed in git are kept; `--keep` keeps all. |
92
+ | `quiver import <folder>` | Move every skill in a folder and its subfolders into the library. Files that are not valid skills are listed at the end. |
93
+ | `quiver import <skill>` | Move one skill: its `SKILL.md`, its folder or a markdown file with frontmatter. `--name` renames it. |
82
94
  | `quiver add <id>...` | Assign skills to this project, or to every folder with `--global`. `--always` makes them always-on. |
83
95
  | `quiver remove <id>...` | Unassign skills. They stay in the library. |
84
96
  | `quiver list` | List the library's skills and where each is assigned (`--source`, `--unassigned`, `--json`). |
85
- | `quiver status` | Show the project in this folder and the skills served here. |
86
- | `quiver where <id>` | Show where one skill is assigned. |
97
+ | `quiver show <id>` | Show a skill: where it comes from, where it is assigned, its files and its `SKILL.md` (`--json`). |
98
+ | `quiver search <text>` | Search the IDs, names and descriptions of every library skill, also unassigned ones, and show whether each is served here (`--json`). |
99
+ | `quiver status` | Show the project in this folder and the skills served here, with a warning for each copy Claude Code also loads (`--json`). |
100
+ | `quiver where <id>` | Show where one skill is assigned (`--json`). |
87
101
  | `quiver source add <repo>` | Clone a skill repository: `owner/repo` (GitHub), a git URL or a local path. |
88
102
  | `quiver source list` | List sources with their skill count and commit. |
89
103
  | `quiver source remove <name>` | Delete a source. Refuses while its skills are assigned, unless `--force`. |
90
104
  | `quiver update [<name>...]` | Pull the latest skills of all or some sources, and list what changed. |
91
- | `quiver projects` | List projects; `rename`, `forget` and `split` manage them. |
92
- | `quiver doctor` | Check the library, the assignments and the Claude Code setup (`--fix` applies the safe fixes). |
93
- | `quiver mcp install` | Register the MCP server with Claude Code (`--print` shows the setup for other assistants). |
94
- | `quiver mcp uninstall` | Remove it from Claude Code. |
105
+ | `quiver projects` | List projects (`--json`); `rename`, `forget` and `split` manage them. |
106
+ | `quiver doctor` | Check the library, the assignments, copies of served skills in Claude Code and its setup (`--fix` applies the safe fixes). |
107
+ | `quiver mcp install` | Register the MCP server with every installed assistant: Claude Code and Cursor (`--for <assistant>` for one, such as `claude-desktop`). |
108
+ | `quiver mcp uninstall` | Remove it from them (`--for <assistant>` for one). |
109
+ | `quiver mcp config` | Print the MCP config entry for any other assistant. |
95
110
  | `quiver mcp` | Run the MCP server. Assistants start this. |
96
111
  | `quiver completion <shell>` | Print the completion script for `bash`, `zsh`, `fish` or `powershell`. |
97
112
 
@@ -105,7 +120,19 @@ quiver completion zsh > "${fpath[1]}/_quiver"
105
120
 
106
121
  ## MCP server
107
122
 
108
- `quiver mcp install` runs `claude mcp add --scope user quiver -- <path to quiver> mcp`. For an assistant configured with JSON, `quiver mcp install --print` prints the entry:
123
+ `quiver mcp install` sets up Claude Code and Cursor when it finds them, or only the assistant named with `--for`:
124
+
125
+ | Assistant | `--for` | What it changes |
126
+ |---|---|---|
127
+ | Claude Code | `claude-code` | Runs `claude mcp add --scope user quiver -- <path to quiver> mcp`. |
128
+ | Cursor | `cursor` | Adds `quiver` to `mcpServers` in `~/.cursor/mcp.json`. |
129
+ | Claude Desktop | `claude-desktop` | Adds `quiver` to `mcpServers` in `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows). Only with `--for claude-desktop`. |
130
+
131
+ An assistant counts as installed when the `claude` command is on `PATH`, or when its config folder exists. In the JSON files, every other key stays as it is, including an `env` of the `quiver` entry, and the old file is saved next to it as `<file>.quiver-backup`. A file that is not valid JSON is reported and never overwritten. Restart Cursor or Claude Desktop afterwards. `quiver doctor` checks the entry of each installed assistant (of Claude Desktop only when it has one). Cursor and Claude Desktop get the path of the binary itself, never the npm launcher, because desktop apps do not see your shell's `PATH` and so cannot find `node`. Cursor passes the skill list to the model and starts the server in the workspace folder, so project skills work there.
132
+
133
+ **Claude Desktop** runs Quiver's tools but does not pass the server's instructions to the model, so it never sees the skill list or the always-on skills. A skill is used only when you ask for Quiver's skills in the prompt, such as "check the quiver skills for this". That is why `quiver mcp install` sets it up only with `--for claude-desktop`. See [docs/spike-mcp-clients.md](docs/spike-mcp-clients.md).
134
+
135
+ For any other assistant, `quiver mcp config` prints the entry:
109
136
 
110
137
  ```json
111
138
  { "mcpServers": { "quiver": { "command": "/path/to/quiver", "args": ["mcp"] } } }
@@ -113,7 +140,7 @@ quiver completion zsh > "${fpath[1]}/_quiver"
113
140
 
114
141
  The server serves the project of the folder it is started in, or of `$QUIVER_PROJECT` when that is set. It logs to `~/.quiver/logs/`.
115
142
 
116
- Claude Code starts the server in the project folder. Other assistants may start it somewhere else, such as your home folder; there it serves only the global skills. Set `QUIVER_PROJECT` in that assistant's MCP config to serve a project's skills.
143
+ Claude Code starts the server in the project folder. Other assistants may start it somewhere else, such as your home folder; there it serves only the global skills. Cursor starts it in the workspace folder. Claude Desktop never starts it in a project. Set `QUIVER_PROJECT` in that assistant's MCP config to serve a project's skills.
117
144
 
118
145
  **Instructions.** When a session starts, the server tells the assistant which skills exist here: their IDs and descriptions, the always-on skills, and that new skills are saved with `create_skill`.
119
146
 
@@ -121,7 +148,7 @@ Claude Code starts the server in the project folder. Other assistants may start
121
148
 
122
149
  | Tool | Input | Result |
123
150
  |---|---|---|
124
- | `list_skills` | — | The skills served here: ID, name, description, and `global` or `project`. |
151
+ | `list_skills` | — | Every skill served here, project skills first: ID, name, whole description, `global` or `project`, and whether it is always-on. |
125
152
  | `get_skill` | `id` | The skill's instructions, its extra files and its folder. |
126
153
  | `get_skill_file` | `id`, `path` | One extra file of a skill, such as `references/checklist.md`. Large and binary files return their path instead. |
127
154
  | `create_skill` | `name`, `description`, `body`, `scope` (`project` or `global`), optional `files` | Creates a local skill, commits it and assigns it. In a folder that is not a project yet, `project` scope registers it. |
@@ -145,16 +172,20 @@ Skills give instructions to your assistant, and a skill can include scripts the
145
172
  - Source skills are read-only in Quiver. To change one, copy it into your own skills.
146
173
  - `create_skill` lets the assistant write skills into your library. A global skill's description reaches the assistant in every folder, so review new global skills with `quiver list` and `quiver edit`.
147
174
 
175
+ To report a vulnerability in Quiver itself, see [SECURITY.md](SECURITY.md).
176
+
148
177
  ## Uninstall
149
178
 
150
179
  The last command deletes your own skills too. To keep them, first push `~/.quiver/local` somewhere: it is a git repository.
151
180
 
152
181
  ```sh
153
- quiver mcp uninstall # remove the MCP server from Claude Code
182
+ quiver mcp uninstall # remove the MCP server from every assistant
154
183
  rm "$(command -v quiver)" # remove the binary; with npm: npm uninstall -g @kheif/quiver
155
184
  rm -rf ~/.quiver # delete the library
156
185
  ```
157
186
 
187
+ On Windows, after `quiver mcp uninstall`, delete `%LOCALAPPDATA%\Programs\quiver` and `%USERPROFILE%\.quiver`, and remove the folder from your user `PATH` in the environment variables settings.
188
+
158
189
  Projects keep their `.quiver.json`; delete it there if you no longer need it.
159
190
 
160
191
  ## Development
@@ -165,7 +196,7 @@ make test # go test ./..., including the end-to-end suite in e2e/
165
196
  make lint # golangci-lint
166
197
  ```
167
198
 
168
- See [PROJECT.md](PROJECT.md) for the design and [tasks/](tasks/README.md) for the plan.
199
+ See [CONTRIBUTING.md](CONTRIBUTING.md), [PROJECT.md](PROJECT.md) for the design and [tasks/](tasks/README.md) for the plan.
169
200
 
170
201
  ## License
171
202
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kheif/quiver",
3
- "version": "1.1.0",
3
+ "version": "1.2.0",
4
4
  "description": "Central skill manager for AI assistants, delivered as an MCP server.",
5
5
  "license": "Apache-2.0",
6
6
  "keywords": [
@@ -26,11 +26,11 @@
26
26
  "node": ">=18"
27
27
  },
28
28
  "optionalDependencies": {
29
- "@kheif/quiver-darwin-arm64": "1.1.0",
30
- "@kheif/quiver-darwin-x64": "1.1.0",
31
- "@kheif/quiver-linux-arm64": "1.1.0",
32
- "@kheif/quiver-linux-x64": "1.1.0",
33
- "@kheif/quiver-win32-arm64": "1.1.0",
34
- "@kheif/quiver-win32-x64": "1.1.0"
29
+ "@kheif/quiver-darwin-arm64": "1.2.0",
30
+ "@kheif/quiver-darwin-x64": "1.2.0",
31
+ "@kheif/quiver-linux-arm64": "1.2.0",
32
+ "@kheif/quiver-linux-x64": "1.2.0",
33
+ "@kheif/quiver-win32-arm64": "1.2.0",
34
+ "@kheif/quiver-win32-x64": "1.2.0"
35
35
  }
36
36
  }