#OKF

#Packages

#Load and query

let set = @okf.DocumentSet::of_texts([
  ("kb/index.md", "---\nokf_version: \"0.2\"\n---\n"),
  ("kb/tables/orders.md", "---\ntype: BigQuery Table\ntitle: Orders\n---\nSee [customers](customers.md).\n"),
])
let knowledge = @okf.discover(set)            // every directory whose index.md has okf_version
let bundle = knowledge.bundles()[0]
let orders = bundle.concept(@okf.ConceptId("tables/orders")).unwrap()
orders.concept_type()                          // Some(ConceptType "BigQuery Table")
orders.links()                                 // body links with their origin and kind
let graph = @okf.Graph::build(knowledge)       // outbound links, backlinks, orphans, broken links
knowledge.filter([TypeIs(@okf.ConceptType("metric")), HasTag("finance")])
knowledge.facet(Type)                          // or Tags, Bundles, Field(@okf.FieldKey("owner"))
@okf.search_knowledge(knowledge, @okf.SearchRequest("revenue", limit=@okf.SearchLimit(10)))

#Domain types

#Validate

let report = @okf.validate(
  knowledge,
  [@okf.okf_v02_conformance(), @okf.advisory()],
  @okf.FixedClock::at("2026-10-23T00:00:00Z"),
  config=@okf.ValidationConfig(
    overrides=[(@okf.RuleName("link-broken"), Error)],
    disabled=[@okf.RuleName("duplicate-title")],
  ),
)
report.findings()      // sorted by severity, subject, line and rule
report.fails(strict=true)

#Edit

@edit.set_key(text, @okf.FieldKey("status"), "deprecated")
@edit.add_index_entry(index_text, @edit.SectionName("Metric"), @edit.IndexEntryLine("Revenue", "/metrics/revenue.md"))
@edit.add_log_entry(log_text, @okf.LogDate("2026-10-23"), "Added revenue.", label="Creation")
let plan = @edit.plan_add_concept(
  bundle, "/metrics/revenue.md", @okf.ConceptType("Metric"), "Revenue",
  "Net revenue per day", @okf.LogDate("2026-10-23"),
)
plan.render()          // a dry run

#Stores, indexes and search

• Writable uses FileSystemFileHandle.createWritable() on the page.
• SyncAccessWorker sends each write to a dedicated worker that writes with createSyncAccessHandle(). The worker writes one file at a time, replaces the whole file in one session (truncate, write, flush, close), and closes the handle before it answers. When a step fails, it closes the handle and removes a file that it created. A failure after the truncate, such as a quota error during the write, can leave an existing file empty or partly written; createWritable() does not have this limit. The worker code is part of the package, so a page serves no extra file. One worker serves every store of the page. A worker that fails or does not answer within two minutes is stopped, and the next write starts a new one.
• The worker opens the origin private file system by itself, so worker writes need a store in that file system: a store from origin_private, or a store over origin_private_root() or a directory below it. A store over a directory that the user selected refuses worker writes with InvalidPath.
• Auto, the default, uses createWritable() when the browser has it, and the worker otherwise. The store chooses once, at its first write.

#Profiles

#OpenSpec

# openspec/ears.yaml
name: my-project
systems: [Mission Control, Text comparison]
lead_ins: [for each]