auto-medica-labs/okf-cli

okf-cli Handbuch

Installieren und verwenden Sie okf-cli für die Arbeit mit dem Open Knowledge Format (OKF)

Installation

uv tool install okf-cli
okf --version

Aktualisierung:

uv tool upgrade okf-cli

Befehle

okf bundle — einfaches Markdown in OKF-Bündel konvertieren

okf bundle <input-verzeichnis> [output-verzeichnis] [--default-type <typ>] [--force] [--strict-links]

Argument	Beschreibung
input-dir	Verzeichnis mit einfachen .md-Dateien
output-dir	Zielverzeichnis (Standard: bundled)
--default-type	Typ für Dateien auf oberster Ebene — weglassen, wenn diese Dateien ignoriert werden sollen
--force, -f	Ausgabeverzeichnis überschreiben, falls es bereits existiert
--strict-links	Fehlschlagen, wenn lokale Markdown-Links auf Dateien außerhalb des Bündels oder auf fehlende .md-Ziele verweisen

okf bundle meine-dokumente gebuendelt --default-type referenz
okf bundle meine-dokumente gebuendelt --default-type referenz --force
okf bundle meine-dokumente gebuendelt --default-type referenz --strict-links

.okfignore — im Stammverzeichnis des input-dir platzieren, ein bundle-relativer Pfad pro Zeile:

# diese Dateien überspringen
rauch-ignorieren.md
tabellen/bestellungen.md

okf list — Konzept-IDs in einem Bündel auflisten

okf list <verzeichnis>

Gibt Konzept-IDs aus (Pfad ohne .md-Endung). Reservierte Dateien (index.md, log.md) werden ausgeschlossen.

okf list gebuendelt/
# datensaetze/umsatz
# tabellen/bestellungen
# tabellen/kunden

okf show — ein Konzept anhand seiner ID anzeigen

okf show <verzeichnis> <konzept-id>

okf show gebuendelt/ tabellen/bestellungen

okf validate — OKF-Konformität prüfen

okf validate <verzeichnis>

Validiert gemäß OKF §9: Frontmatter vorhanden, type nicht leer, reservierte Dateinamen folgen der Struktur.

okf validate gebuendelt/

Eingabeformat für bundle

Jede .md-Datei sollte dieser Struktur folgen:

# Klarer Konzepttitel

> Ein-Satz-Zusammenfassung dieses Konzepts.

Textkörper mit nützlichem Kontext, Struktur, Beispielen oder Schema.

Regeln:

• Erste Zeile: # Titel
• Zweiter Block: > Beschreibung (prägnant, sachlich)
• Der Verzeichnisname wird zum Konzept-type: tabellen/bestellungen.md → Typ tabellen
• Dateien auf oberster Ebene erfordern --default-type
• Fügen Sie Quell-Dateien kein Frontmatter hinzu — okf bundle generiert es
• Vermeiden Sie die Erstellung von index.md, log.md oder README.md als Quellkonzepte (durch die Spezifikation reserviert)