Open Knowledge CLI Documentation

Commands

Use this index to select a command for your task. Run okn <command> --help to see the exact CLI syntax.

Start here

  • setup: Create a managed copy or adopt Markdown in place.
  • check: Run configured checks and report one status.
  • search: Search managed or ordinary Markdown.
  • view: Browse the bundle in the local viewer.
  • review: Create and optionally run an agent review task.
  • publish: Build configured viewer or MCP output.
  • upgrade: Upgrade the OKF format explicitly.

Advanced

  • validate: Validate OKF conformance directly.
  • audit: Find concrete knowledge risks and their evidence.
  • claims: Maintain evidence-backed typed claims and lifecycle history.
  • evidence: Capture immutable evidence artifacts and receipts.
  • eval: Test retrieval evidence against versioned questions.
  • quality: Combine observations into quality metrics, priorities, and an intervention audit log.
  • query: Run SPARQL, Datalog, or hybrid semantic queries.
  • export: Create HTML, JSON, graph, RDF, or tar output.
  • mcp: Serve read-only MCP resources and tools.
  • connect: Register a local or remote bundle.
  • disconnect: Remove a connection.
  • registry: List, inspect, refresh, and resolve connections.
  • automation: Run jobs, insights, runtimes, and deployments.
  • agent: Run a steered Codex, Claude Code, or OpenCode session.
  • get: Read an exact page or entrypoint.
  • list: Inspect the bundle structure.
  • scaffold: Create a deterministic bundle without an agent.
  • prompt: Print maintenance and review instructions.
  • ast: Inspect the parsed document model.
  • spec: Print an embedded OKF specification.
  • version: Print the CLI version.
  • telemetry: Inspect or change anonymous product telemetry.
  • help: Read about global flags and help.
Powered by OpenKnowledge.sh