Documentation
Plugin
open-knowledge
Highlights: Full true WYSIWYG so that editing markdown files feels like editing a Google Doc or Notion page. macOS app and web UI with file navigator, search, tabs, graph wiki link viewer, and more.
Plugin Signal85/100Strong
maintained100
capable61
documented100
adopted75
Install
$ npx -y skills add inkeep/open-knowledge --agent claude-code
Run the curl in your terminal, the rest in Claude Code.
Stats
3,328
Stars
209
Forks
Active
Maintenance
TypeScript
Language
GPL-3.0
License
4h ago
Last commit
2mo ago
Created
Repo: inkeep/open-knowledge
What's inside
Skills
18/discoveryRead when the user asks what OpenKnowledge is, wants to install it on a repository, wants to open or preview a single markdown file that is not part of an OpenKnowledge project, wants to share an OpenKnowledge project with collaborators, or asks how `ok init` / `ok cowork` / OK/codebase-wikiHow 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/entity-vaultHow 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/knowledge-baseHow 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/consolidatePromote existing research into a 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,/researchInvestigate a topic against preserved sources and write a provisional 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
Show all 18 skillsShow fewer
/okfHow to work in an OKF starter project (the `okf` starter pack): a knowledge base that is conformant with Google's Open Knowledge Format (OKF) from commit one — `concepts/`, `references/`, `notes/`, a reserved `index.md` navigation hub, and a reserved `log.md` change history./plain-notesHow 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./software-lifecycleHow 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/frame-a-proposalFrame 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/record-a-decisionRecords 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/review-a-designReviews 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/write-a-postmortemWrite 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/write-a-specScope a feature end to end and write an implementation spec under specs/ from an accepted proposal — current-system mapping, goals/non-goals, a Decision Log for one-way-door choices, a live Open Questions backlog, and a real migration + test plan. Read when asked to write a/worldbuildingHow to work in a Worldbuilding project (the `worldbuilding` starter pack): a fiction encyclopedia of characters, settings, themes, factions, and lore. Read when the project has these folders, OR when asked to add a character, setting, faction, or piece of lore, or to check the/writing-pipelineHow to work in a Writing Pipeline project (the `writing-pipeline` starter pack): a three-stage drafting flow, ideas → drafts → published. Read when the project has these folders, OR when asked to capture an idea, start or revise a draft, review a piece before it ships, or/projectAuthoritative agent-runtime contract for working inside an OpenKnowledge project — a markdown-CRDT knowledge base exposed over MCP. Use whenever reading, listing, searching, editing, or linting any `.md` or `.mdx` file in the project, and before any `mcp__open-knowledge__*` tool/write-skillUse 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
README
1Features
Highlights:
- Full true WYSIWYG so that editing markdown files feels like editing a Google Doc or Notion page.
- macOS app and web UI with file navigator, search, tabs, graph wiki link viewer, and more.
- Integrated side-by-side AI-editing with Claude, Codex, OpenCode, Pi and others. Can be used with any harness/agent via MCP/CLI.
- Out-of-the-box MCP, skills, and agentic search for LLM Wikis, second brains, and knowledge graphs.
- No-code Team sharing and Auto-sync powered by git/GitHub under the hood.
- Embeddable HTML and rich components for writing engineering specs and visualized reports.
Install
macOS: download the desktop app — open the DMG, drag OpenKnowledge to Applications, and launch it. Latest release.
Linux, Windows, Intel Mac: run the same editor as a local web app via the CLI (Node.js 24+ and git required):
npm install -g @inkeep/open-knowledge
cd your-project
ok init # scaffold the project + wire up your AI editors (Claude Code, Claude Desktop, Cursor, Codex, OpenCode, OpenClaw)
ok start --open # serve the web editor and open it in your browser
Usage
Use OpenKnowledge by opening any existing folder on your computer that contains markdown or mdx files. The app can be used with existing codebases, wikis, Obsidian vaults, etc.
Think of it as Notion meets VS Code.
You can use it simply as a rich, WYSIWYG markdown editor to start. For existing files or plain notes/docs.
To get more complex, you can use the starter packs to create LLM Wikis, second brains, or more structured knowledge bases.
Either way, the app will walk you through installing the MCP and skills for agent harnesses detected on your computer. These are designed to help agents with enriched search + authoring of documents.
Git/GitHub based sync and sharing can optionally be enabled.
Docs for general usage: https://openknowledge.ai/docs.
Contributions
Public pull requests or issues are welcome!
See CONTRIBUTING.md for details.
License
OpenKnowledge is licensed under GNU General Public License v3.0 or later, an OSI-Approved open source license.
Community & Support
Feel free to file an issue or ask questions on the Discord community. We're always looking for ideas and requests.
File tree
1894inkeep/open-knowledgeView on GitHub
.changeset/
acp-agent-capabilities.md
acp-agent-path-augment.md
acp-message-queue.md
acp-thread-improvements.md
agents-panel-new-conversation.md
auth-rejection-structured-log.md
bridge-loss-hardening.md
bug-report-interface-language.md
bug-report-renderer-telemetry.md
centralize-collaboration-host.md
checkpoint-tie-and-redo-chords.md
collapse-folder-name-with-space.md
comment-rail-toolbar-overlap.md
comments-panel-one-list-two-scopes.md
config.json
copy-image-portable.md
default-theme-tile-own-colors.md
diagnose-bundle-consent-posture.md
div-align-render.md
editor-bottom-dock-empty-gap.md
epoch-rotation-recycle.md
explore-openknowledge-skills.md
frontmatter-schema-toggle-only.md
h1-title-fallback.md
overlay-global-shortcut-gate.md
pool-snapshot-render-loop.md
pre.json
preserve-marks-on-inline-leaf-nodes.md
preview-tabs-toggle.md
quiet-pans-repeat.md
README.md
remote-tunnel-v0.md
saveable-custom-themes.md
server-config-keys.md
server-lock-v2-url-contract.md
settings-row-density-and-descriptions.md
ship-remaining-interface-locales.md
shipit-install-failure-evidence.md
slash-menu-emoji.md
table-last-row-enter.md
templates-as-content.md
terminal-right-panel.md
tripwire-whole-document-paste.md
wave3-ui-default-flip.md
wide-bug-report-dialog.md
write-thematic-break-frontmatter.md
.env.example
.github/
CODEOWNERS
ISSUE_TEMPLATE/
bug_report.yml
config.yml
feature_request.yml
PULL_REQUEST_TEMPLATE.md
scripts/
bridge-public-pr-to-monorepo.mjs
bridge-public-pr-to-monorepo.test.mjs
bug-lane.mjs
bug-lane.test.mjs
build-smoke-alert-payload.mjs
build-smoke-alert-payload.test.mjs
cla-gate.mjs
cla-gate.test.mjs
derive-release-stamp.mjs
derive-release-stamp.test.mjs
dmg-mount.mjs
dmg-mount.test.mjs
evaluate-smoke-alarm.mjs
evaluate-smoke-alarm.test.mjs
point-release-plan.mjs
point-release-plan.test.mjs
release-cascade-shape.test.mjs
resolve-shipped-version.mjs
resolve-shipped-version.test.mjs
select-beta-to-promote.mjs
select-beta-to-promote.test.mjs
smoke-packaged-dmg.mjs
smoke-packaged-dmg.test.mjs
stamp-by-containment.mjs
stamp-by-containment.test.mjs
write-back-gate.mjs
write-back-gate.test.mjs
write-back.mjs
write-back.test.mjs
SECURITY.md
workflows/
bug-lane.yml
desktop-build-win-linux.yml
desktop-build.yml
desktop-release-draft-janitor.yml
desktop-release.yml
linear-release.yml
monorepo-pr-bridge.yml
native-config-prebuild.yml
point-release.yml
promote-stable.yml
publish-linux-repo.yml
release.yml
select-beta-to-promote.yml
stale.yml
write-back.yml
.gitignore
.node-version
.npmrc
AGENTS.md
assets/
hero.webp
ok-wordmark-dark.svg
ok-wordmark.svg
biome-plugins/
__fixtures__/
class-proof-registration-discipline.fixture.tsx
cst-pm-handler-todo-stub.fixture.tsx
microcopy-ellipsis.fixture.tsx
no-blind-agent-host-fanout.fixture.tsx
no-inline-tolerance-class.fixture.tsx
no-loosely-typed-webcontents-ipc.fixture.tsx
no-physical-direction-utility.fixture.tsx
no-raw-html-interactive-element.fixture.tsx
no-resolved-value-theme-source.fixture.tsx
no-roundtrip-identity-oracle.fixture.tsx
no-split-suggestion-dispatch.fixture.tsx
no-uninstall-forbidden-import.fixture.tsx
no-unportaled-editor-content.fixture.tsx
no-unwrapped-user-facing-string.fixture.tsx
path-conditional-map-driven-origin.fixture.tsx
playwright-prefer-to-have-count.fixture.tsx
require-windowshide-on-spawn.fixture.tsx
class-proof-registration-discipline.grit
cst-pm-handler-todo-stub.grit
microcopy-ellipsis.grit
no-blind-agent-host-fanout.grit
no-hand-rolled-spinner.grit
no-inline-tolerance-class.grit
no-loosely-typed-webcontents-ipc.grit
no-physical-direction-utility.grit
no-raw-html-interactive-element.grit
no-resolved-value-theme-source.grit
no-roundtrip-identity-oracle.grit
no-split-suggestion-dispatch.grit
no-uninstall-forbidden-import.grit
no-unportaled-editor-content.grit
no-unwrapped-user-facing-string.grit
path-conditional-map-driven-origin.grit
playwright-prefer-to-have-count.grit
README.md
require-windowshide-on-spawn.grit
biome.jsonc
CLA.md
CONTRIBUTING.md
docs/
_snippets/
.gitkeep
.env.example
.gitignore
CHANGELOG.md
components.json
content/
advanced/
content-rules/
frontmatter.mdx
markdownlint.mdx
meta.json
overview.mdx
folders-and-templates.mdx
meta.json
contribute/
meta.json
translations.mdx
deploy/
connecting-agents.mdx
meta.json
remote-access.mdx
features/
agent-activity.mdx
assets-and-embeds.mdx
editor.mdx
github-sync.mdx
ignore-patterns.mdx
meta.json
share.mdx
skills.mdx
timeline-and-recovery.mdx
get-started/
meta.json
overview.mdx
quickstart.mdx
integrations/
antigravity.mdx
claude-code.mdx
codex.mdx
cursor.mdx
github-copilot-cli.mdx
hermes.mdx
lm-studio.mdx
meta.json
openclaw.mdx
opencode.mdx
pi.mdx
meta.json
migrate/
meta.json
notion.mdx
obsidian.mdx
plugins/
meta.json
overview.mdx
slidev.mdx
reference/
agentic-search.mdx
cli.mdx
components/
accordion.mdx
audio.mdx
callout.mdx
embed.mdx
file.mdx
html-align-block.mdx
img.mdx
index.mdx
math.mdx
mermaid-fence.mdx
meta.json
mirror.mdx
pdf.mdx
tabs.mdx
toggle.mdx
video.mdx
configuration.mdx
core-concepts.md
mcp.mdx
meta.json
what-open-knowledge-writes.mdx
workflows/
codebase-wiki.mdx
entity-vault.mdx
karpathy-llm-wiki.mdx
meeting-ingestion.mdx
meta.json
plain-notes.mdx
software-lifecycle.mdx
supporting-open-knowledge-format.mdx
worldbuilding.mdx
writing-pipeline.mdx
next-env.d.ts
next.config.ts
package.json
postcss.config.ts
public/
favicon.ico
images/
home/
block-components/
image-preview.png
video-preview.png
cta-shape-left.svg
cta-shape-right.svg
dotted-bg-left.svg
hero-box-background.webp
hero-dotted-bg.svg
pillar-2-gradient.webp
ok-logo.png
ok-wordmark.svg
screenshots/
timeline-diff-view.png
Wide.png
scripts/
generate-brand-assets.ts
generate-component-docs.ts
generate-og-wordmark.ts
package.json
validate-link.ts
source.config.ts
src/
app/
.well-known/
apple-app-site-association/
route.ts
api/
search/
route.ts
continue/
done/
route.ts
page.tsx
d/
[encoded]/
download/
route.test.ts
route.ts
opengraph-image.test.ts
opengraph-image.tsx
page.tsx
splash-buttons.tsx
splash-cli-block.tsx
splash-cli-button.tsx
splash-cli-popover.tsx
splash-cta-cluster.tsx
splash-cta-panel.tsx
splash-download-split-button.tsx
splash-share-view.tsx
docs/
[...slug]/
page.tsx
changelog/
[tag]/
page.tsx
page.tsx
rss.xml/
route.ts
layout.tsx
page.tsx
download/
beta/
route.test.ts
route.ts
stable/
route.test.ts
route.ts
global.css
layout.tsx
llms-full.txt/
route.ts
llms.mdx/
[...slug]/
route.test.ts
route.ts
llms.txt/
route.ts
og/
docs/
[...slug]/
route.tsx
opengraph-image.tsx
provider.tsx
robots.ts
sitemap.ts
updates/
[channel]/
[...path]/
route.test.ts
route.ts
components/
agent-icons.tsx
changelog-timeline.tsx
component-preview.tsx
copy-prompt.tsx
cta-button.tsx
docs-sidebar-cta.tsx
docs-sidebar-separator.tsx
dot-texture.tsx
download-button.tsx
footer.tsx
html-preview.tsx
icons/
antigravity.tsx
brand.ts
claude.tsx
codex.tsx
cursor.tsx
discord.tsx
github.tsx
hermes.tsx
mcp.tsx
obsidian.tsx
openclaw.tsx
opencode.tsx
pi.tsx
x.tsx
inkeep-logo.tsx
inkeep-search-and-chat.tsx
marketing-button.tsx
mcp-install.tsx
mermaid.tsx
ok-wordmark.tsx
overview-blocks.tsx
page-markdown-actions.tsx
previews/
accordion-preview.tsx
callout-preview.tsx
file-preview.tsx
lucide-lookup.ts
math-preview.tsx
media-previews.tsx
mirror-previews.tsx
tabs-preview.tsx
product-updates-form.tsx
seo/
json-ld.tsx
slide-page.tsx
tabs.test.ts
tabs.tsx
ui/
dropdown-menu.tsx
input.tsx
popover.tsx
verify-exec.tsx
hsts-header.test.ts
instrumentation-client.ts
... 1600 moreShowing a partial view of a very large repo.
FAQ
open-knowledge is a Claude Code plugin with 18 hand-picked skills for documentation work, indexed on Flowy. Install it with the command on its page. It includes discovery, codebase-wiki, entity-vault. Its skills do not fire on their own yet. Request auto-invocation to have Flowy route them as you prompt. Free and open source.
- What is open-knowledge?
- Highlights: Full true WYSIWYG so that editing markdown files feels like editing a Google Doc or Notion page. macOS app and web UI with file navigator, search, tabs, graph wiki link viewer, and more.
- How do I install open-knowledge?
- Run these in Claude Code: npx -y skills add inkeep/open-knowledge --agent claude-code. Then prompt normally.
- Does open-knowledge auto-invoke its skills?
- Not yet. It is indexed on Flowy as a plain plugin. Request auto-invocation on its page and Flowy will route its skills for you as you prompt.
- Is open-knowledge free?
- Yes. Flowy is free and open source, with nothing gated. You can read every skill in full before you install.