Skip to content

Commit cdd2597

Browse files
committed
docs(readme): strip didactic noise from install section
Three trims: - Dropped the agentskills.io link (community/third-party site, not Anthropic-official; risks looking like a placeholder reference). - Removed the bullet explanations of what each /plugin command does and the /plugin UI alternative paragraph — the two commands are self-explanatory, the explanations were noise. - Removed the 'why we use --path' note for Gemini and the 'after install' summary — the SKILL.md link covers what users need. Result: 3 install snippets + one safety sentence, ~half the length.
1 parent df1f030 commit cdd2597

1 file changed

Lines changed: 5 additions & 22 deletions

File tree

README.md

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

239239
### Using with Claude Code / Codex / Gemini CLI
240240

241-
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.
241+
OpenKB ships a `SKILL.md` so any agent CLI can read your compiled wiki — no extra runtime, no MCP setup, just install the skill once.
242242

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

247245
```
248246
/plugin marketplace add VectifyAI/OpenKB
249247
/plugin install openkb@vectify
250248
```
251249
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](https://geminicli.com/docs/cli/skills/) fetches the skill folder from this repo. `--path skills/openkb` points it at the sub-directory containing `SKILL.md` (the rest of the repo is the openkb codebase, not skill content):
250+
**Gemini CLI**:
262251
263252
```bash
264253
gemini skills install https://github.com/VectifyAI/OpenKB.git --path skills/openkb --consent
265254
```
266255

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:
256+
**OpenAI Codex CLI** (no marketplace command yet — manual symlink):
270257

271258
```bash
272259
git clone https://github.com/VectifyAI/OpenKB.git ~/openkb-src
273260
mkdir -p ~/.agents/skills
274261
ln -s ~/openkb-src/skills/openkb ~/.agents/skills/openkb
275262
```
276263

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-
#### After install
280-
281-
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.
264+
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.
282265

283266
# 🧭 Learn More
284267

0 commit comments

Comments
 (0)