{
  "markdown": "<div align=\"center\">\n\n# OKFView\n\n**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).**\n\n[![CI](https://github.com/ryansann/okfview/actions/workflows/ci.yml/badge.svg)](https://github.com/ryansann/okfview/actions/workflows/ci.yml)\n[![Release](https://img.shields.io/github/v/release/ryansann/okfview?sort=semver)](https://github.com/ryansann/okfview/releases)\n[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)\n[![OKF](https://img.shields.io/badge/OKF-v0.1-2ea44f)](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md)\n[![MCP](https://img.shields.io/badge/MCP-enabled-5f43b2)](docs/okf/reference/mcp-tools.md)\n![Platform: macOS](https://img.shields.io/badge/platform-macOS-lightgrey)\n![Built with: Electron + TypeScript](https://img.shields.io/badge/built%20with-Electron%20%2B%20TypeScript-2ea44f)\n\n</div>\n\n## Demos\n\n### For humans\n\n[![OKFView preview](docs/assets/demos/okfview-preview.gif)](docs/assets/demos/okfview-preview.mp4)\n\n[Watch the full in-app demo](docs/assets/demos/okfview-preview.mp4)\n\n### For agents\n\n[![OKFView agent demo](docs/assets/demos/okfview-agent-demo.gif)](docs/assets/demos/okfview-agent-demo.mp4)\n\n[Watch the full agent demo](docs/assets/demos/okfview-agent-demo.mp4)\n\n## What is OKFView?\n\n[OKF](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md) is\nGoogle Cloud's open standard for representing knowledge as a directory of Markdown files\nwith YAML frontmatter.\n\n**OKFView** turns OKF into a shared knowledge layer across all the places you work: local\nprojects, documentation folders, reference bundles, and coding agent sessions. Open the\nknowledge once, scope what should be shared, and let humans and agents browse the same live\ncontext over a polished desktop UI and the Model Context Protocol.\n\nThink of it as:\n\n```text\nOKF >> skills\n```\n\nSkills are useful entry points, but OKF gives you a finer-grained web of documents:\nconcepts, references, backlinks, process notes, conformance checks, and relationships that\ncan be progressively disclosed instead of dumped into one long prompt or one giant\ndirectory. That makes it a better home for tacit project knowledge: how systems are shaped,\nwhy decisions were made, what workflows matter, and which references an agent should use\nbefore touching code.\n\n## Why it matters\n\n- **Bridge every project** - keep reusable knowledge in OKF bundles and open them wherever you need context.\n- **Share context across agent sessions** - expose selected bundles over MCP instead of re-explaining the same project history.\n- **Progressively disclose knowledge** - agents can list bundles, inspect tables of contents, read one concept, follow links, and search when needed.\n- **Encode tacit process** - capture decisions, workflows, review rules, domain notes, and references as linked documents, not scattered instructions.\n- **Keep humans in the loop** - browse, validate, and edit the same knowledge graph your agents consume.\n\n## Features\n\n- **Document view** - rendered Markdown with frontmatter, schema tables, citations, outgoing links, and backlinks.\n- **Graph view** - an interactive concept graph, colored by type, with click-to-navigate links.\n- **Command palette** - full-text search (`Cmd+K` / `Ctrl+K`) across every open bundle, including body text.\n- **Local and remote sources** - open a folder, git repo (`...repo.git#subpath`), or `.tar.gz` URL.\n- **Live sync** - file edits appear instantly without losing your place; remote sources poll for updates.\n- **MCP server** - expose scoped bundles to coding agents so they can browse, search, and validate OKF.\n- **Diagnostics** - embedded okftool validation surfaces spec conformance and lint feedback without blocking viewing.\n- **Persistence** - open bundles auto-restore; recent bundles and aliases are remembered.\n\n## okftool feedback loop\n\nOKFView embeds [okftool](https://github.com/ryansann/okftool), the validator and linter for\nOKF bundles. The viewer stays permissive: non-conformant bundles still open, with issues\nshown as diagnostics. Agents can use the same okftool-backed MCP validation tools as a\nfeedback loop while authoring, so they can generate bundles that are not just valid, but\nwell structured for graph navigation and progressive disclosure. Strictness is configurable\nin Settings, and a bundle can define its own policy with `.okftool.yml` or `.okftool.yaml`\nat the bundle root.\n\n## Install (macOS)\n\nDownload the latest `.dmg` (arm64 or x64) from the\n[**Releases**](https://github.com/ryansann/okfview/releases) page and drag OKFView to\nApplications.\n\nPublic macOS releases are Developer ID signed and notarized. See\n[Security](SECURITY.md#packaging-and-macos-signing) for packaging details.\n\nOther platforms can [build from source](CONTRIBUTING.md).\n\n## Quick start\n\n1. **Open a bundle** - click **Open folder...** and pick an OKF directory (try this repo's own [`docs/okf/`](docs/okf/index.md)).\n2. **Explore** - read in the document view, switch to the graph, press `Cmd+K` / `Ctrl+K` to search.\n3. **Connect an agent** - in **Settings > Agents (MCP)**, enable the server and share a bundle, then:\n\n   ```bash\n   claude mcp add --transport http okfview http://127.0.0.1:7331/mcp\n   ```\n\n## Documentation\n\nOKFView documents itself **in the format it views**: the docs are a native, conformant OKF\nbundle at [**`docs/okf/`**](docs/okf/index.md); open it in the app to browse the\narchitecture, features, reference, and design decisions as a graph.\n\n- [Architecture](docs/okf/architecture/index.md)\n- [Features](docs/okf/features/index.md)\n- [Reference](docs/okf/reference/index.md)\n- [Decisions](docs/okf/decisions/index.md)\n- [MCP tools reference](docs/okf/reference/mcp-tools.md)\n- [DESIGN.md](DESIGN.md)\n\n## Contributing\n\nOKFView is open source and contributions are welcome; see\n[CONTRIBUTING.md](CONTRIBUTING.md) for dev setup, the repo layout, and the PR flow. Please\nalso review the [Code of Conduct](CODE_OF_CONDUCT.md), [Security Policy](SECURITY.md), and\n[Support guide](SUPPORT.md).\n\n## License\n\n[Apache-2.0](LICENSE), matching the OKF ecosystem.\n",
  "bytes": 6252,
  "sha": "a5651a68754e20474bf9fc15c035e96c4739f0e589d8be551af2e33e77a9af0e",
  "repo_slug": "ryansann/okfview",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/okf_ryansann_okfview_docs_okf_index_md_fc65aabf/readme"
}