auto-medica-labs/okf-cli

okf-cli マニュアル

okf-cli をインストールして、Open Knowledge Format (OKF) を扱うための操作を行います

インストール

uv tool install okf-cli
okf --version

アップグレード:

uv tool upgrade okf-cli

コマンド

okf bundle — プレーンなMarkdownをOKFバンドルに変換

okf bundle <入力ディレクトリ> [出力ディレクトリ] [--default-type <タイプ>] [--force] [--strict-links]

引数	説明
入力ディレクトリ	プレーンな .md ファイルのディレクトリ
出力ディレクトリ	出力先ディレクトリ（デフォルト: bundled）
--default-type	ルートレベルのファイルに対する型 — 省略時はルートファイルをスキップ
--force, -f	出力先ディレクトリが存在する場合に上書きする
--strict-links	ローカルのMarkdownリンクがバンドル外や存在しない .md を指している場合に失敗させる

okf bundle my-docs bundled --default-type reference
okf bundle my-docs bundled --default-type reference --force
okf bundle my-docs bundled --default-type reference --strict-links

.okfignore — 入力ディレクトリ のルートに配置し、1行につき1つのバンドル相対パスを記述:

# これらのファイルをスキップ
smoke-ignore.md
tables/orders.md

okf list — バンドル内の概念IDを一覧表示

okf list <ディレクトリ>

概念ID（.md を除去したパス）を出力します。予約ファイル（index.md、log.md）は除外されます。

okf list bundled/
# datasets/sales
# tables/orders
# tables/customers

okf show — IDで概念を表示

okf show <ディレクトリ> <概念ID>

okf show bundled/ tables/orders

okf validate — OKF準拠性をチェック

okf validate <ディレクトリ>

OKF §9 に従って検証: フロントマターが存在すること、type が空でないこと、予約ファイル名が構造に従っていること。

okf validate bundled/

bundle の入力形式

各 .md ファイルは次の構造に従う必要があります:

# 明確な概念タイトル

> この概念の1文要約。

有用なコンテキスト、構造、例、スキーマを含む本文。

ルール:

• 1行目: # タイトル
• 2ブロック目: > 説明（簡潔で事実に基づく）
• ディレクトリ名が概念の type になります: tables/orders.md → type tables
• ルートレベルのファイルには --default-type が必要
• ソースファイルにフロントマターを追加しないでください — okf bundle が自動生成します
• ソース概念として index.md、log.md、README.md を作成しないでください（仕様で予約されています）