Use cases / Knowledge CI

Catch stale knowledge before it ships.

Add source checks and retrieval tests when other people or production agents depend on your wiki.

Add checks after the local wiki works

okn setup github Wiki --plan

Example output · abbreviated plan

{
  "profile": "github",
  "plan": true,
  "created": ["/your-project/.github/workflows/openknowledge.yml"]
}

Preview the workflow file that setup would create. No files are written in plan mode.

okn setup github Wiki

Example output · abbreviated setup result

{
  "profile": "github",
  "plan": false,
  "created": ["/your-project/.github/workflows/openknowledge.yml"]
}

Writes the GitHub workflow locally. Commit and push it to run the checks in GitHub Actions.

Review the plan before applying it. The GitHub setup adds a source baseline, starter evaluation questions, workflow configuration, and maintenance controls.

Knowledge CI setup guide

Check the questions people actually ask

okn check Wiki

Example output · abbreviated healthy wiki

Knowledge status

Structure       READY
Links           READY
Freshness       NOT CONFIGURED
Retrieval       NOT CONFIGURED
Overall         READY

Structure and links pass. Freshness and retrieval checks stay optional until you configure them.

okn eval run evals/questions.yaml Wiki --base main --gate regressions

Illustrative output · comparison excerpt

gate regressions

  unchanged_pass  citation-policy

PASS: 0 improved, 0 regressed, 0 proposed failures

Compare retrieval against main. A regression makes the gate fail; results depend on your dataset and changes.

Replace evals/questions.yaml with your dataset. Retrieval tests check whether expected evidence is returned. Generated-answer evaluation requires an agent runner.

A READY status covers configured checks. It does not certify freshness or retrieval when those layers are not configured.

Review changes before publication

okn review Wiki

Example output · copied review task excerpt

# Open Knowledge Content Review

Review scope: `changed`
Deterministic validation: 0 errors, 0 warnings.

Treat findings as advisory.

Choose an installed agent, copy the task, or save it. The task guides a review; it is not a completed review result.

okn publish Wiki --target viewer --out ./site --plan

Example output · abbreviated publication plan

Publication plan

Knowledge base:   /your-project/Wiki
OKF version:      0.2
  VIEWER   6 files -> /your-project/site

Shows the local viewer bundle to build. Remove --plan to write it; hosting is a separate step.

Enable viewer in release.outputs before planning publication. Checks gate configured outputs; publication remains explicit. Schedule agent maintenance only after configuring its runtime and permissions.

Publication reference

See the knowledge it uses

This repository’s own wiki documents its commands, design decisions, and release history.

Open the Open Knowledge wiki

Set up your knowledge base

Follow the setup guide Explore other workflows