Documentation

Open Source · v0.2 · MIT License

Open CKF

Self-hostable Compiler and Viewer. Open-source, 100% browser-side. No backend, BYOK, host anywhere.

What it is

Open CKF ships the same engine that powers compiledknowledgeformat.org as two independent static SPAs — no database, no login, no server. Clone, build, host.

The hosted site still works

The official /compiler and /viewer on the hosted site are unchanged. Open CKF is a separate package for local execution, dedicated VPS, or white-label integrations.

The two packages

ckf-viewer

Opens .ckf files, renders typed sections, rules and definitions, and enables the source-traceability inspector.

ckf-compiler

Compiles raw text into CKF. Includes Heuristic Mode (offline) and BYOK support (OpenAI, Anthropic, Google, DeepSeek, OpenRouter) called directly from the client.

When to use it

  • Privacy / sensitive data — nothing leaves the browser except the direct BYOK call to the provider.
  • Air-gapped environments — Heuristic Mode runs 100% offline.
  • White-label and custom integrations.
  • Source customization — read, fork, modify.

🔒 Zero telemetry by design

The Open CKF code has no trackers, analytics, or hidden metadata collection. BYOK calls go directly from the browser to the providers' official API endpoints. 100% auditable via the browser DevTools Network tab.

Quick start

bash
git clone https://github.com/tomazinho/open-ckf-compiled-knowledge-format
cd open-ckf-compiled-knowledge-format

# Run the Viewer
cd packages/ckf-viewer
npm install && npm run dev

# Run the Compiler
cd ../ckf-compiler
npm install && npm run dev

Running npm run build in either package emits a static /dist folder, ready to drop into GitHub Pages, Netlify, S3, Vercel, nginx — or opened directly as a local file (base: "./").

The KnowOps pipeline on your infrastructure

Open CKF transposes the governance principles of the KnowOps (Knowledge Operations) framework directly into your control. By self-hosting the Compiler and Viewer, your organization builds a sovereign, auditable pipeline to turn manuals, policies and books into schema-stable inference structures — mitigating Composition Hallucination without surrendering data custody or control over knowledge distribution.

Limitations vs the hosted site

FeatureHosted siteOpen CKF (self-host)
Advanced AI free (login gateway - allowlist)Free on the site (with limits)Unavailable — requires BYOK or an authenticated gateway
Compile historyPersisted via account/sessionNot persisted — fully ephemeral and local
Rate-limit sovereigntyCentrally managed by IPUnlimited — bounded only by your API key quotas

CKF v1.0 for this page has not been compiled yet. Downloads become available once an admin runs the compiler.