メニュー
Use when the user reports a problem with OpenKnowledge, asks for help debugging OK, or wants to file a bug report. This skill guides the agent to capture diagnostic information via the ok bug-report CLI command.
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
Read when the user asks what OpenKnowledge is, wants to install it on a repository, wants to share an OpenKnowledge project with collaborators, or asks how `ok init` / `ok cowork` / OK Desktop set up a project. Do NOT load to perform OpenKnowledge reads/writes — the runtime guidance for editing markdown inside an initialized OK project ships as a separate project-local skill at `.claude/skills/open-knowledge/` whenever `ok init` runs. If the user appears to be editing markdown inside a `.ok/` project and this is the only OK skill loaded, advise them to re-run `ok init` to install the project-local skill.
Authoritative agent-runtime contract for working inside an OpenKnowledge project — a markdown-CRDT knowledge base exposed over MCP. Use whenever reading, listing, searching, or editing any `.md` or `.mdx` file in the project, and before any `mcp__open-knowledge__*` tool call (`exec`, `search`, `write`, `edit`, and the rest). Installed by `ok init`, so its presence means this is an OpenKnowledge project and it governs every markdown file here. Covers the read/write tool surface, grounding and linking rules, folder/template conventions, the live browser preview, and the rule that OK's MCP tools — never native file tools — handle in-scope markdown.
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), the SKILL.md frontmatter contract, progressive-disclosure structure, evaluating the skill, and installing it into the user's editors.
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`. Carries the per-folder rules and freshness + log discipline, summarizes the audience/depth knobs and source-reference convention, and points to the `workflow({ kind: 'wiki' })` guide for the full generate/refresh procedure. Complements the platform `open-knowledge` skill; does not replace it.
How to work in an Entity vault 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. 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.
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/` — wired to the `workflow` MCP tool's ingest / research / consolidate kinds. Carries the pack's workflow, per-folder rules, status flows, and log discipline so this guidance does NOT live inside template bodies or log.md. Complements the platform `open-knowledge` skill; does not replace it.
| name | open-knowledge-bug-report |
| description | Use when the user reports a problem with OpenKnowledge, asks for help debugging OK, or wants to file a bug report. This skill guides the agent to capture diagnostic information via the ok bug-report CLI command. |
| compatibility | Any MCP host (Claude Code, Cursor, Codex, Windsurf) with OpenKnowledge MCP server registered. |
| metadata | {"version":"0.6.0","author":"Inkeep","repository":"https://github.com/inkeep/open-knowledge"} |
When a user reports a problem with OpenKnowledge or asks for debugging help, use the ok bug-report command to capture a structured diagnostic bundle.
ok bug-report --no-reveal
The --no-reveal flag suppresses the Finder reveal (use it when running as an agent — you want the file path, not a Finder window).
~/.ok/logs/ (NDJSON format, pino)~/.ok/bug-reports/<timestamp>-bugreport.zip<timestamp>-bugreport.zip
├── MANIFEST.json — what's inside, redaction audit report
├── sysinfo.json — versions, locale, disk, build channel
├── README.md — what's safe to share, discipline version
├── logs/ — NDJSON log files (auto-redacted)
├── lockdir/ — server.lock, spawn-error-log (if project)
└── recent-ipc-errors.json — last 50 structured IPC errors
ok bug-report --no-reveal in the user's project directory (or home if no project)unzip -o <path> -d /tmp/ok-diag-<timestamp>/MANIFEST.json — check the redactions array (if non-empty, some content was scrubbed)sysinfo.json — check versions, disk space, build channelgrep '"level":50' logs/*.log | head -20 (level 50 = error in pino)recent-ipc-errors.json for IPC-layer failuresThe ok bug-report command ships with @inkeep/open-knowledge >= 0.7.0. If the user's version is older:
ok --versionnpm install -g @inkeep/open-knowledge@latest to update~/.ok/logs/ for recent .log files (NDJSON format, greppable)The bundle auto-redacts:
/Users/<name>/ → ~/)ghp_, gho_, ghu_, ghs_, ghr_)The MANIFEST.json redactions array lists every file and pattern that was scrubbed. The bundle is safe for the user to attach to a GitHub issue.