Open Knowledge CLI Documentation
Frontmatter5 fields
Trust
UnverifiedDefault
Status
StableDefault

Generated by process:openknowledge-docs

type
Feature Documentation
title
OKF 0.2 Compliance
description
Compliance and capability matrix for Open Knowledge CLI support of OKF 0.2.
generated
at
by
process:openknowledge-docs

OKF 0.2 Compliance

This page maps OKF 0.2 to Open Knowledge CLI behavior. It is not an upstream certification.

Version support

The CLI embeds OKF 0.1 and 0.2. The latest selector resolves to 0.2. Validation uses a separate rule profile for each version. Every emitted rule, its default severity, override permission, section reference, and optional version-specific checker is selected from that profile.

okn spec 0.2
okn validate --spec 0.2 Wiki
okn scaffold --spec 0.1 ./legacy-wiki

New scaffolds use latest and declare okf_version: "0.2" by default. Use --spec 0.1 to create a 0.1 scaffold. Validation, inline list diagnostics, parsing, and creation accept either supported version.

Status legend

StatusMeaning
✅ SupportedThe behavior has focused implementation and test evidence.
🟡 PartialThe CLI preserves the data but does not provide all semantic behavior.
➖ DeferredOKF 0.2 does not define enough runtime behavior to implement it portably.

Conformance rules

OKF 0.2 ruleStatusCLI behavior
Parseable YAML frontmatter on conceptsInvalid or missing frontmatter is an error.
Non-empty concept typeA missing or empty value is an error. Unknown types remain valid.
Reserved index.md and log.md structure🟡Core rules pass. Non-root indexes also allow Open Knowledge publication metadata.
Missing optional families remain valid0.2 metadata diagnostics are warnings.
Unknown keys remain validThe parser preserves complete typed YAML data.
Broken links remain validBroken local links produce warnings.
Missing indexes remain validValidation does not require an index.
Bare verified mapping becomes one eventVersioned AST and bundle reads normalize the mapping to a one-item list.

See §11 Conformance.

New 0.2 metadata

The okf-0.2-metadata rule checks optional 0.2 families. Its default severity is warning. It is not part of the OKF 0.1 validation profile, so an 0.1 validation ignores it in shared .openknowledge.toml configuration. An explicit CLI --rule must belong to the selected profile.

FamilyChecks
sourcesList and entry shapes, required resource, unique IDs, dates, counts, and usage windows.
Per-claim attributionFootnote labels match sources[].id.
generatedMapping shape, actor convention, and ISO 8601 date-time.
verifiedMapping or list shape, actor convention, and ISO 8601 date-time.
Lifecyclestatus values and stale_after date form.
Attested ComputationRuntime, parameters, nested contracts, and one computation form.

These checks do not reject a conformant bundle. OKF 0.2 makes these families optional and gives most family constraints soft conformance status.

The validator accepts fenced and indented computation blocks. The upstream worked examples use indented blocks even though §10.3 specifies a fenced block.

Consumer and exporter support

SurfaceStatusBehavior
AST and JSON bundlePreserve all nested 0.2 frontmatter and unknown keys.
Search and contextIndex nested frontmatter as searchable metadata.
List outputText output shows derived trust, status, and staleness. JSON entries expose the complete derived okf02 contract.
Source graphNodes expose okf02. Source, computation, executor, and attester resources create typed provenance edges. External or unresolved resources use resource nodes.
Local and default static viewerShows trust, status, freshness, provenance, structured sources, resolved source footnotes, and Attested Computation contracts.
Plain HTML exportRenders semantic frontmatter. OKF 0.2 source footnotes link to matching structured source entries.
Tar export and registryPreserve source Markdown and the selected spec version.
ScaffoldUses 0.2 by default. An explicit 0.1 scaffold uses timestamp and embeds the 0.1 spec.

Trust derivation follows OKF 0.2: no verification is unverified, only non-human verification is machine-confirmed, and any human: verification is human-reviewed. Missing status is stable. A concept is stale on or after its stale_after date in the local calendar.

The viewer and exported contracts preserve Attested Computation runtime, parameters, computation, executor, receipt, and attester metadata. They do not execute any declared resource.

Migration behavior

OKF 0.2 supersedes two 0.1 conventions:

  • generated.at supersedes timestamp.
  • sources and source-keyed footnotes supersede # Citations.

The CLI accepts legacy timestamp as an unknown field. Default scaffolds use generated. Explicit 0.1 scaffolds use timestamp. The CLI does not convert a legacy # Citations list to sources. OKF 0.2 makes that fallback optional.

Deferred runtime behavior

The CLI does not execute an executor or attester. OKF 0.2 records the computation and its means, but it does not define a portable invocation ABI, sandbox policy, receipt or verdict format, or cache contract. The viewer makes this boundary explicit. Execution requires a separately approved runtime and deterministic attester.

Powered by OpenKnowledge.sh