pi-okf-search

Search a local Open Knowledge Format (OKF) Markdown directory from Pi. The package uses a native Rust/Tantivy backend to build an in-memory index. It adds one read-only tool, okf_search, which returns ranked snippets with source paths and line ranges. The /okf command provides utilities for inspecting and refreshing the index.

Quick start

Install the package:

pi install npm:pi-okf-search

Add pi-okf-search to ~/.pi/agent/settings.json:

{
  "pi-okf-search": {
    "root": "/absolute/path/to/knowledge"
  }
}

Start Pi and ask it to search:

Search the knowledge base to find the rollback procedure.

Inspect the loaded index

Run /okf status to confirm which directory Pi loaded, which document types it found, whether the loaded snapshot has degraded documents, and how recently it built the in-memory index.

The Degraded row shows how many documents in the loaded snapshot need repair. 0 · clean means none do.

Configuration

root is the only supported setting. It must be a nonblank string.

| Scope | Settings file | Relative roots start from | | --- | --- | --- | | Global | ~/.pi/agent/settings.json | ~/.pi/agent | | Project | .pi/settings.json | .pi |

Project level setting replaces the global setting. Use an absolute path when you do not want resolution to depend on the settings location.

Search and results

By default, okf_search searches every indexed field, matches any query term, tolerates minor typos, and returns up to five results. The model can narrow a search by field or filter by document type, tag, status, trust tier, or staleness. It can require every query term with match: "all", disable typo tolerance with fuzzy: false, or request up to 10 results. Once the final query term reaches three characters, it also matches prefixes—even when typo tolerance is enabled.

A result looks like this:

1 hit

1. Database rollback
   Heading: Restore snapshot
   /Users/alice/project/knowledge/runbooks/database-rollback.md:9-11
   Matched: title, body
   Restore the last known-good snapshot, then verify application health.

The path is absolute and the line range is inclusive.

No matches. means the index returned no evidence for that query; it does not prove the information is absent.

Indexing and refreshes

The extension recursively indexes .md files under root, except files named exactly index.md or log.md. The index is held in memory and does not modify source files.

Changes to the root setting or its Markdown files do not appear in search results automatically. Run /okf refresh to update the index. A successful refresh resets the age shown by /okf status; if it fails, Pi keeps using the previous index.

Requirements

Requires Node.js >=22.19.0. Prebuilt native addons support macOS x64/arm64 and Linux x64 with glibc >=2.17; Windows x64 is experimental. Other platforms are not currently supported.

Development

From the repository root:

pnpm install
pnpm --filter okf-search-native build
pi -e ./packages/pi-okf-search/extensions/okf-search/index.ts
pnpm package:check

The native backend must be built before running the extension from this checkout. pnpm package:check runs the repository's build, typecheck, tests, packing, and packed-consumer checks.

License

MIT. See the repository LICENSE.