Skip to content

Commit 38e236f

Browse files
committed
docs(skill): tighten README install section, document per-CLI flow
Three improvements: 1. **Explain the two-step Claude Code flow.** Users asked why `install` alone isn't enough — clarified that `marketplace add` registers the GitHub repo as a marketplace source named `vectify`, and `install openkb@vectify` then installs FROM that source. The `@vectify` suffix is a marketplace reference, not a package alias. 2. **Note the `/plugin` interactive UI alternative.** Users with newer Claude Code versions can browse and install via a menu — but the marketplace still has to be registered first. 3. **Add a "Manual install (any agent)" fallback.** Skip the installer entirely by symlinking `skills/openkb` into the agent's skills directory. Useful for development, offline boxes, and sandboxed environments where the marketplace fetch is blocked. 4. **Add removal/update commands** for Claude Code (`/plugin uninstall`, `/plugin marketplace remove`) and Codex (`cd ... && git pull`).
1 parent fe123ee commit 38e236f

1 file changed

Lines changed: 33 additions & 5 deletions

File tree

README.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -240,30 +240,58 @@ OpenKB's wiki is a directory of Markdown files with `[[wikilinks]]`. Obsidian re
240240

241241
OpenKB ships a [SKILL.md](https://agentskills.io/) so any agent CLI can read your compiled wiki — no extra runtime, no MCP setup, just install the skill once.
242242

243-
**Claude Code** (via the plugin marketplace):
243+
#### Claude Code
244+
245+
Two commands — first register OpenKB as a plugin marketplace, then install the skill from it:
244246

245247
```
246248
/plugin marketplace add VectifyAI/OpenKB
247249
/plugin install openkb@vectify
248250
```
249251

250-
**Gemini CLI** (native skills installer):
252+
- `/plugin marketplace add VectifyAI/OpenKB` reads `.claude-plugin/marketplace.json` from the repo's default branch and registers `vectify` as a known marketplace.
253+
- `/plugin install openkb@vectify` installs the `openkb` plugin from that marketplace. The `@vectify` suffix names the marketplace, not the package.
254+
255+
Alternative — `/plugin` (interactive UI) lets you browse registered marketplaces and install with one click, but you still need to `marketplace add` first to register the source.
256+
257+
To remove later: `/plugin uninstall openkb` then `/plugin marketplace remove VectifyAI/OpenKB`.
258+
259+
#### Gemini CLI
260+
261+
Native skills installer fetches a single skill folder from a Git repo:
251262

252263
```bash
253264
gemini skills install https://github.com/VectifyAI/OpenKB.git --path skills/openkb --consent
254265
```
255266

256-
**OpenAI Codex CLI** (no marketplace yet — manual install):
267+
#### OpenAI Codex CLI
268+
269+
Codex has no marketplace command yet — install by cloning the repo and symlinking the skill folder into one of its discovery paths:
257270

258271
```bash
259272
git clone https://github.com/VectifyAI/OpenKB.git ~/openkb-src
260273
mkdir -p ~/.agents/skills
261274
ln -s ~/openkb-src/skills/openkb ~/.agents/skills/openkb
262275
```
263276

264-
(Codex discovers skills under `.agents/skills/` walking up from cwd, or `~/.agents/skills/` for user-scope.)
277+
Codex discovers skills under `.agents/skills/` walking up from cwd, or `~/.agents/skills/` for user-scope. To update later: `cd ~/openkb-src && git pull`.
278+
279+
#### Manual install (any agent)
280+
281+
If you don't want to use any installer, just drop the skill folder into the agent's user-scope skills directory:
282+
283+
```bash
284+
# Claude Code
285+
ln -s "$(pwd)/skills/openkb" ~/.claude/skills/openkb
286+
# Gemini CLI
287+
ln -s "$(pwd)/skills/openkb" ~/.gemini/skills/openkb
288+
# Codex
289+
ln -s "$(pwd)/skills/openkb" ~/.agents/skills/openkb
290+
```
291+
292+
#### After install
265293

266-
After install, when the user asks about content in their OpenKB knowledge base, the skill activates and points the agent at `openkb status` to discover the KB, `openkb list` for the catalog, and direct Markdown reads for concept/summary content. The skill is read-only: it won't run `openkb add`, `remove`, or `lint --fix` without you asking. See [`skills/openkb/SKILL.md`](skills/openkb/SKILL.md) for the full instruction set the agent receives.
294+
When you ask about content in an OpenKB knowledge base, the skill activates and points the agent at `openkb status` to discover the KB root, `openkb list` for the document catalog, and direct Markdown reads for concept and summary content. The skill is read-only: it won't run `openkb add`, `remove`, or `lint --fix` without you asking. See [`skills/openkb/SKILL.md`](skills/openkb/SKILL.md) for the full instruction set the agent receives.
267295

268296
# 🧭 Learn More
269297

0 commit comments

Comments
 (0)