Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions skills/core/open-knowledge-discovery/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ linking rules, the MCP routing table) — that ships separately as the
project-local skill installed by `ok init` (see *Working inside a project*
below).

> **CLI name.** Commands below use Stable's `ok` (`open-knowledge`). OpenKnowledge
> Beta's terminal commands are `ok-beta` (`open-knowledge-beta`), with `~/.ok-beta/`
> in place of `~/.ok/`.

## Install OpenKnowledge on a repository

Run `ok init` from the repository root:
Expand Down
2 changes: 1 addition & 1 deletion skills/core/open-knowledge-write-skill/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: open-knowledge-write-skill
description: "Use when the user wants to create, author, write, or design a new Agent Skill (a SKILL.md) — for OpenKnowledge or for their editors — including requests like 'help me write a skill', 'make a skill that…', 'turn this workflow into a skill', or improving an existing skill's triggering and discipline. Also use when capturing reusable agent guidance that should live as an installable skill rather than a one-off prompt. Covers choosing scope (project vs global), authoring inside a plugin or skills-distribution repo (write in the repo's own layout, never install), the SKILL.md frontmatter contract, progressive-disclosure structure, evaluating the skill, and installing it into the user's editors."
compatibility: "OpenKnowledge project recommended (uses the `write` / `edit` / `install` MCP verbs). Authoring + validation are pure file ops; live preview + eval want a running server (`ok start`)."
compatibility: "OpenKnowledge project recommended (uses the `write` / `edit` / `install` MCP verbs). Authoring + validation are pure file ops; live preview + eval want a running server (`ok start`, or `ok-beta start` for Beta)."
metadata:
author: "Inkeep"
repository: "https://github.com/inkeep/open-knowledge-skills"
Expand Down
2 changes: 2 additions & 0 deletions skills/core/open-knowledge/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ OpenKnowledge (OK) is a markdown-CRDT collaboration platform exposed via MCP. Th

> Skill version tracks `@inkeep/open-knowledge-server`. `cat ~/.ok/skill-state.yml` shows what's installed. `ok seed` needs `@inkeep/open-knowledge` >= 0.4.0; if it errors `unknown command`, `npm install -g @inkeep/open-knowledge`.

> **CLI name.** Commands here use Stable's `ok` (`open-knowledge`) and `~/.ok/`. With OpenKnowledge Beta, use `ok-beta` (`open-knowledge-beta`) and `~/.ok-beta/` instead; `preview_url`'s `okOpenCommand` already names the right one.

> **Setup (not connected yet?).** If the `mcp__open-knowledge*` tools aren't available in your client, this project isn't wired up on this machine — see [`references/setup.md`](references/setup.md) for the rung ladder (approve `.mcp.json` → `ok start` CLI → optional desktop app) and the canonical quickstart.

## TL;DR — the 90% case
Expand Down
2 changes: 1 addition & 1 deletion skills/starter-packs/codebase-wiki/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ code changes rather than rotting beside it.

## Install

- Seed a project: `ok seed --pack codebase-wiki`
- Seed a project: `ok seed --pack codebase-wiki` (`ok-beta` for Beta)
- Claude Code plugin: `/plugin install codebase-wiki@open-knowledge-skills`
2 changes: 1 addition & 1 deletion skills/starter-packs/codebase-wiki/codebase-wiki/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: codebase-wiki
description: "How to work in a Codebase Wiki project (the `codebase-wiki` starter pack): an agent-authored, source-grounded wiki of the surrounding codebase. Read when the project has a `wiki/` knowledge base with `architecture/`, `modules/`, `flows/`, `concepts/`, and `guides/` sections plus `wiki/OVERVIEW.md`, or when asked to generate or refresh a wiki of this codebase. Carries the per-folder rules and freshness + log discipline, summarizes the audience/depth knobs and source-reference convention, and bundles the full generate/refresh procedure in `references/`. Complements the platform `open-knowledge` skill; does not replace it."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack codebase-wiki`."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack codebase-wiki` (`ok-beta` for Beta)."
metadata:
pack: "codebase-wiki"
author: "Inkeep"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ The content directory is the resolved `content.dir` — read it with `config({ k

**Two toolsets, two jobs.** Read source code with your NATIVE tools (`Read`/`Grep`/`Glob`/`Bash` — OK MCP does not index non-markdown source). Author and audit the wiki with OK MCP verbs (`write`/`edit` for pages, `links`/`search` for the graph, `exec` for markdown listings). Never hand-write the wiki markdown with native `Write`/`Edit` — that bypasses attribution, backlinks, and the live preview.

**Server requirement.** Phases that author or audit the wiki (`write`/`edit`/`links`/`search`) need the OK Hocuspocus server. Source reading (native tools) and git do not. If a `write` returns "Hocuspocus server is not running", tell the user to run `ok start` and retry — do NOT fall back to native file writes for the wiki markdown.
**Server requirement.** Phases that author or audit the wiki (`write`/`edit`/`links`/`search`) need the OK Hocuspocus server. Source reading (native tools) and git do not. If a `write` returns "Hocuspocus server is not running", tell the user to run `ok start` (`ok-beta start` for Beta) and retry — do NOT fall back to native file writes for the wiki markdown.

**Prerequisite.** This procedure assumes the `codebase-wiki` pack is seeded (`ok seed --pack codebase-wiki` → `wiki/` with `architecture/ modules/ flows/ concepts/ guides/`, each carrying folder frontmatter + a page template, plus `wiki/OVERVIEW.md` + `wiki/log.md`). If `exec("ls -A <content-dir>/wiki")` shows the layout is missing, tell the user to seed first, then start over.
**Prerequisite.** This procedure assumes the `codebase-wiki` pack is seeded (`ok seed --pack codebase-wiki`, or `ok-beta` for Beta, → `wiki/` with `architecture/ modules/ flows/ concepts/ guides/`, each carrying folder frontmatter + a page template, plus `wiki/OVERVIEW.md` + `wiki/log.md`). If `exec("ls -A <content-dir>/wiki")` shows the layout is missing, tell the user to seed first, then start over.

---

Expand Down Expand Up @@ -154,7 +154,7 @@ Incremental by default — don't re-read the whole repo.

## Exit conditions

- **Pack not seeded** — `wiki/` layout missing → tell the user to run `ok seed --pack codebase-wiki`, then start over. Exit.
- **Server down** — a `write`/`links` call reports the server is not running → tell the user to run `ok start` and retry. Exit cleanly; resuming keeps already-written pages.
- **Pack not seeded** — `wiki/` layout missing → tell the user to run `ok seed --pack codebase-wiki` (`ok-beta` for Beta), then start over. Exit.
- **Server down** — a `write`/`links` call reports the server is not running → tell the user to run `ok start` (`ok-beta start` for Beta) and retry. Exit cleanly; resuming keeps already-written pages.
- **User aborts at a STOP gate** → exit cleanly, leaving any already-written pages in place.
- **Empty / unreadable repo** (no source detected in Phase 1) → tell the user there's nothing to document yet. Exit.
2 changes: 1 addition & 1 deletion skills/starter-packs/knowledge-base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ skill exists so an agent picks the right one instead of improvising.

## Install

- Seed a project (folders, templates, and all three skills): `ok seed --pack knowledge-base`
- Seed a project (folders, templates, and all three skills): `ok seed --pack knowledge-base` (`ok-beta` for Beta)
- Claude Code plugin (all three skills): `/plugin install knowledge-base@open-knowledge-skills`
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: consolidate-notes
description: "Promote existing research into a stable-status canonical article under `articles/` in a Knowledge Base project (the `knowledge-base` starter pack). Read when a decision has actually been made and the team wants the source-of-truth written down, or when asked to consolidate, canonicalize, promote research, or supersede an older article. Carries the decision-confirmation gate, the `supersedes:` chain that keeps the evidence trail intact, and the canonical voice. Does not conduct new research — that is the sibling `research-with-sources` skill."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack knowledge-base`."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack knowledge-base` (`ok-beta` for Beta)."
type: Document
metadata:
pack: "knowledge-base"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: knowledge-base
description: "How to work in a Knowledge Base project (the `knowledge-base` starter pack). Read when the project has the three-layer source-grounded layout — `external-sources/` → `research/` → `articles/` — or when asked how this project is organized. Carries the layer model, per-folder rules, status flows, and log discipline so this guidance does NOT live inside template bodies or log.md. The three procedures live elsewhere: ingest in the platform `open-knowledge` skill, research and consolidate as their own sibling skills in this pack. Complements the platform `open-knowledge` skill; does not replace it."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack knowledge-base`."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack knowledge-base` (`ok-beta` for Beta)."
type: Document
metadata:
pack: "knowledge-base"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: research-with-sources
description: "Investigate a topic against preserved sources and write a draft-status research article under `research/` in a Knowledge Base project (the `knowledge-base` starter pack). Read when asked to research a topic, compare options, synthesize sources, gather evidence, or extend an existing research doc. Carries the full procedure: scan existing coverage, agree a research rubric, capture every source verbatim before analyzing, write the article incrementally so a crash never loses work, cite every claim, and link it back into the graph. Does not promote findings to canonical knowledge — that is the sibling `consolidate-notes` skill, after a decision lands."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack knowledge-base`."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack knowledge-base` (`ok-beta` for Beta)."
type: Document
metadata:
pack: "knowledge-base"
Expand Down
2 changes: 1 addition & 1 deletion skills/starter-packs/note-taking/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ships is named `note-taking`.

## Install

- Seed a project (folders, templates, and the skill together): `ok seed --pack plain-notes`
- Seed a project (folders, templates, and the skill together): `ok seed --pack plain-notes` (`ok-beta` for Beta)
- Claude Code plugin: `/plugin install note-taking@open-knowledge-skills`

The skill assumes the pack's folder layout exists, so seeding is the primary
Expand Down
2 changes: 1 addition & 1 deletion skills/starter-packs/note-taking/note-taking/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: note-taking
description: "How to work in a Plain Notes project (the `plain-notes` starter pack): a flat notes/ folder plus a daily/ journal. The 'I just want to write' layout. Read when the project has these folders, OR when asked to jot a note, capture a quick thought, or write today's journal entry. Carries the linking habit and daily-entry behavior so templates and folder descriptions stay minimal. Complements the platform `open-knowledge` skill; does not replace it."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack plain-notes`."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack plain-notes` (`ok-beta` for Beta)."
metadata:
pack: "plain-notes"
author: "Inkeep"
Expand Down
2 changes: 1 addition & 1 deletion skills/starter-packs/okf-knowledge-base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ The pack's seed id is `okf`; the skill it ships is named `okf-knowledge-base`.

## Install

- Seed a project: `ok seed --pack okf`
- Seed a project: `ok seed --pack okf` (`ok-beta` for Beta)
- Claude Code plugin: `/plugin install okf-knowledge-base@open-knowledge-skills`
2 changes: 1 addition & 1 deletion skills/starter-packs/personal-crm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ The pack's seed id is `entity-vault`; the skill it ships is named

## Install

- Seed a project: `ok seed --pack entity-vault`
- Seed a project: `ok seed --pack entity-vault` (`ok-beta` for Beta)
- Claude Code plugin: `/plugin install personal-crm@open-knowledge-skills`
2 changes: 1 addition & 1 deletion skills/starter-packs/personal-crm/personal-crm/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: personal-crm
description: "How to work in a Personal CRM project (the `entity-vault` starter pack, GBrain-compatible): a typed-entity vault of people, companies, meetings, and concepts, each a dossier with a rewritable summary plus an append-only timeline. Read when the project has these folders, OR when asked to capture notes about a person or company, log a meeting, prep for an upcoming meeting, or answer who someone is and what was last said. Carries the dossier convention and entity-extraction behaviors so that guidance does not live inside template bodies or folder descriptions. Complements the platform `open-knowledge` skill; does not replace it."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack entity-vault`."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack entity-vault` (`ok-beta` for Beta)."
metadata:
pack: "entity-vault"
author: "Inkeep"
Expand Down
2 changes: 1 addition & 1 deletion skills/starter-packs/software-lifecycle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ scenario instead of improvising a document type.

## Install

- Seed a project (folders, templates, and all six skills): `ok seed --pack software-lifecycle`
- Seed a project (folders, templates, and all six skills): `ok seed --pack software-lifecycle` (`ok-beta` for Beta)
- Claude Code plugin (all six skills): `/plugin install software-lifecycle@open-knowledge-skills`
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: frame-a-proposal
description: "Frame a new design proposal (RFC-shape) under proposals/ — problem before solution, named beneficiary and observable change, real alternatives, honest drawbacks, and a live open-questions backlog. Read when asked to frame a proposal, write an RFC, propose a design, pitch a change, draft a PRD-style design doc, or open a design proposal for review. Do NOT read to record a decision after it is accepted (use record-a-decision), to write an implementation spec (use write-a-spec), to write a postmortem (use write-a-postmortem), or to review or critique an existing design (use review-a-design)."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack software-lifecycle`."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack software-lifecycle` (`ok-beta` for Beta)."
metadata:
pack: "software-lifecycle"
author: "Inkeep"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: record-a-decision
description: "Records an architecture decision as a Nygard/MADR-shaped ADR under decisions/ — capturing the context that forced the choice, the options weighed, the decision itself, and its consequences in both directions, plus the supersedes chain that keeps a decision log honest. Read when asked to record an architecture decision, write an ADR, log the decision we made, document why we chose X over Y, capture this decision for the record, or supersede an old decision with a new one. Do NOT read to frame a proposal or explore an idea not yet decided (frame-a-proposal), to write a spec or implementation plan (write-a-spec), to write an incident postmortem (write-a-postmortem), or to judge whether a design is sound (review-a-design). This skill records a decision already made; it does not make one."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack software-lifecycle`."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack software-lifecycle` (`ok-beta` for Beta)."
metadata:
pack: "software-lifecycle"
author: "Inkeep"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: review-a-design
description: "Reviews whether a design is SOUND — solving the right problem, derived from its stated goals and constraints — and emits ranked, evidence-backed findings, not edits. Read when asked to 'review this design', 'is this design sound', 'pressure-test this proposal', 'do a design review', 'does this solve the right problem', 'poke holes in this spec', 'should we build this', or to critique a proposal / spec / ADR / architecture or product decision. Do NOT read when the user wants to AUTHOR one of these — routing a new proposal is frame-a-proposal, a spec is write-a-spec, a decision record is record-a-decision, a postmortem is write-a-postmortem. Do NOT read for code review of a diff, or to fact-check individual claims (that is a correctness pass, a different job)."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack software-lifecycle`."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack software-lifecycle` (`ok-beta` for Beta)."
metadata:
pack: "software-lifecycle"
author: "Inkeep"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: software-lifecycle
description: "How to work in a Software Lifecycle project (the `software-lifecycle` starter pack): proposals → decisions → specs → postmortems, plus guides. Read when the project has these folders, or when asked how this project is organized. Carries the doc lifecycle, status flows, and per-folder agent behaviors so that guidance does not live inside template bodies or folder descriptions. The five workflows — frame a proposal, write a spec, record a decision, write a postmortem, review a design — each ship as their own sibling skill in this pack. Complements the platform `open-knowledge` skill; does not replace it."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack software-lifecycle`."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack software-lifecycle` (`ok-beta` for Beta)."
metadata:
pack: "software-lifecycle"
author: "Inkeep"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: write-a-postmortem
description: "Write a blameless incident postmortem under postmortems/ following the Google SRE shape — evidence-based timeline, trigger vs root cause vs symptom, contributing factors, what went well, and owned+dated+verifiable action items. Read when asked to write a postmortem, do an incident review, run a root cause analysis, write up the outage, retro on the outage, or when the user says we had an incident and wants it documented. Do NOT read to frame a proposal (use frame-a-proposal), write a spec (use write-a-spec), record a decision (use record-a-decision), or review a design (use review-a-design) — a postmortem documents an incident that already happened, it does not propose, specify, decide, or critique future work."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack software-lifecycle`."
compatibility: "Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack software-lifecycle` (`ok-beta` for Beta)."
metadata:
pack: "software-lifecycle"
author: "Inkeep"
Expand Down
Loading