okfview Knowledge Bundle
Bundle OKF 0.1 · 4 conceitos · ryansann/okfview
Open source Repository Open in the app JSON README (API)
About
# okfview Knowledge Bundle
The design, architecture, and reference for **okfview** — a desktop viewer for Open
Knowledge Format bundles — captured as a native OKF bundle.
# Sections
* [Architecture](architecture/index.md) - How okfview is built: the OKF core, the Electron processes, the context bridge, source adapters, and the MCP server.
* [Features](features/index.md) - What okfview does for people and for agents.
* [Reference](reference/index.md) - The OKF format, frontmatter schema, conformance rules, data model, and MCP tools.
* [Decisions](decisions/index.md) - Why okfview is built the way it is.
Details
- Kind
- OKF bundles
- Topic
- No topic detected
- Publisher
- ryansann
- Origin
- okf_github
- Category
- dados
- Version
- 0.1
- Stars
- 2
- Last push
- 2026-07-06T22:52:51Z
- Repository state
- ativo
- Language
- TypeScript
- License
- NOASSERTION
- Added
- 2026-09-08 09:01:12
- Updated
- 2026-09-08 09:01:12
- Origin id
ryansann/okfview:docs/okf/index.md
README
<div align="center"> # OKFView **A configurable context bridge for your projects, docs, and coding agents, built on [Open Knowledge Format](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md).** [](https://github.com/ryansann/okfview/actions/workflows/ci.yml) [](https://github.com/ryansann/okfview/releases) [](LICENSE) [](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md) [](docs/okf/reference/mcp-tools.md)   </div> ## Demos ### For humans [](docs/assets/demos/okfview-preview.mp4) [Watch the full in-app demo](docs/assets/demos/okfview-preview.mp4) ### For agents [](docs/assets/demos/okfview-agent-demo.mp4) [Watch the full agent demo](docs/assets/demos/okfview-agent-demo.mp4) ## What is OKFView? [OKF](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md) is Google Cloud's open standard for representing knowledge as a directory of Markdown files with YAML frontmatter. **OKFView** turns OKF into a shared knowledge layer across all the places you work: local projects, documentation folders, reference bundles, and coding agent sessions. Open the knowledge once, scope what should be shared, and let humans and agents browse the same live context over a polished desktop UI and the Model Context Protocol. Think of it as: ```text OKF >> skills ``` Skills are useful entry points, but OKF gives you a finer-grained web of documents: concepts, references, backlinks, process notes, conformance checks, and relationships that can be progressively disclosed instead of dumped into one long prompt or one giant directory. That makes it a better home for tacit project knowledge: how systems are shaped, why decisions were made, what workflows matter, and which references an agent should use before touching code. ## Why it matters - **Bridge every project** - keep reusable knowledge in OKF bundles and open them wherever you need context. - **Share context across agent sessions** - expose selected bundles over MCP instead of re-explaining the same project history. - **Progressively disclose knowledge** - agents can list bundles, inspect tables of contents, read one concept, follow links, and search when needed. - **Encode tacit process** - capture decisions, workflows, review rules, domain notes, and references as linked documents, not scattered instructions. - **Keep humans in the loop** - browse, validate, and edit the same knowledge graph your agents consume. ## Features - **Document view** - rendered Markdown with frontmatter, schema tables, citations, outgoing links, and backlinks. - **Graph view** - an interactive concept graph, colored by type, with click-to-navigate links. - **Command palette** - full-text search (`Cmd+K` / `Ctrl+K`) across every open bundle, including body text. - **Local and remote sources** - open a folder, git repo (`...repo.git#subpath`), or `.tar.gz` URL. - **Live sync** - file edits appear instantly without losing your place; remote sources poll for updates. - **MCP server** - expose scoped bundles to coding agents so they can browse, search, and validate OKF. - **Diagnostics** - embedded okftool validation surfaces spec conformance and lint feedback without blocking viewing. - **Persistence** - open bundles auto-restore; recent bundles and aliases are remembered. ## okftool feedback loop OKFView embeds [okftool](https://github.com/ryansann/okftool), the validator and linter for OKF bundles. The viewer stays permissive: non-conformant bundles still open, with issues shown as diagnostics. Agents can use the same okftool-backed MCP validation tools as a feedback loop while authoring, so they can generate bundles that are not just valid, but well structured for graph navigation and progressive disclosure. Strictness is configurable in Settings, and a bundle can define its own policy with `.okftool.yml` or `.okftool.yaml` at the bundle root. ## Install (macOS) Download the latest `.dmg` (arm64 or x64) from the [**Releases**](https://github.com/ryansann/okfview/releases) page and drag OKFView to Applications. Public macOS releases are Developer ID signed and notarized. See [Security](SECURITY.md#packaging-and-macos-signing) for packaging details. Other platforms can [build from source](CONTRIBUTING.md). ## Quick start 1. **Open a bundle** - click **Open folder...** and pick an OKF directory (try this repo's own [`docs/okf/`](docs/okf/index.md)). 2. **Explore** - read in the document view, switch to the graph, press `Cmd+K` / `Ctrl+K` to search. 3. **Connect an agent** - in **Settings > Agents (MCP)**, enable the server and share a bundle, then: ```bash claude mcp add --transport http okfview http://127.0.0.1:7331/mcp ``` ## Documentation OKFView documents itself **in the format it views**: the docs are a native, conformant OKF bundle at [**`docs/okf/`**](docs/okf/index.md); open it in the app to browse the architecture, features, reference, and design decisions as a graph. - [Architecture](docs/okf/architecture/index.md) - [Features](docs/okf/features/index.md) - [Reference](docs/okf/reference/index.md) - [Decisions](docs/okf/decisions/index.md) - [MCP tools reference](docs/okf/reference/mcp-tools.md) - [DESIGN.md](DESIGN.md) ## Contributing OKFView is open source and contributions are welcome; see [CONTRIBUTING.md](CONTRIBUTING.md) for dev setup, the repo layout, and the PR flow. Please also review the [Code of Conduct](CODE_OF_CONDUCT.md), [Security Policy](SECURITY.md), and [Support guide](SUPPORT.md). ## License [Apache-2.0](LICENSE), matching the OKF ecosystem.