cli-anything-obsidian

Was macht cli-anything-obsidian?

Wissensmanagement und Notizen via der Obsidian Local REST API. Entwickelt für KI-Agenten und Power-User, die Notizen verwalten, das Vault durchsuchen und Befehle ohne GUI ausführen möchten.

Installation

Dieses CLI wird als Teil des cli-anything-obsidian-Pakets installiert:

pip install cli-anything-obsidian

Voraussetzungen:

• Python 3.10+
• Obsidian muss installiert und mit dem Local REST API Plugin aktiviert sein

Verwendung

Grundlegende Befehle

# Hilfe anzeigen
cli-anything-obsidian --help

# Interaktiven REPL-Modus starten
cli-anything-obsidian

# Vault-Dateien auflisten
cli-anything-obsidian vault list

# Mit JSON-Ausgabe (für Agenten)
cli-anything-obsidian --json vault list

REPL-Modus

Wenn kein Unterbefehl übergeben wird, startet das CLI eine interaktive REPL-Sitzung:

cli-anything-obsidian
# Befehle interaktiv mit Tab-Vervollständigung und Verlauf eingeben

Befehlskategorien

Vault

Befehle zur Vault-Dateiverwaltung.

Befehl	Beschreibung
list	Dateien im Vault oder einem Unterverzeichnis auflisten
read	Inhalt einer Notiz lesen
create	Eine neue Notiz erstellen
update	Eine vorhandene Notiz überschreiben
delete	Eine Notiz aus dem Vault löschen
append	Inhalt an eine vorhandene Notiz anhängen

Suche

Suchbefehle im Vault.

Befehl	Beschreibung
query	Suche mit der Obsidian-Abfragesyntax
simple	Einfache Textsuche über das gesamte Vault

Notiz

Befehle für die aktive Notiz.

Befehl	Beschreibung
active	Die aktuell aktive Notiz in Obsidian abrufen
open	Eine Notiz im Obsidian-Editor öffnen

Befehl

Befehle der Obsidian-Befehlspalette.

Befehl	Beschreibung
list	Alle verfügbaren Obsidian-Befehle auflisten
execute	Einen Befehl anhand seiner ID ausführen

Server

Serverstatus- und Informationsbefehle.

Befehl	Beschreibung
status	Prüfen, ob die Obsidian Local REST API läuft

Sitzung

Befehle zum Sitzungszustand.

Befehl	Beschreibung
status	Aktuellen Sitzungszustand anzeigen

Beispiele

Notizen auflisten und lesen

# Alle Vault-Dateien auflisten
cli-anything-obsidian vault list

# Dateien in einem Unterverzeichnis auflisten
cli-anything-obsidian vault list "Tägliche Notizen"

# Eine Notiz lesen
cli-anything-obsidian vault read "Projekte/mein-projekt.md"

Notizen erstellen und aktualisieren

# Eine neue Notiz erstellen
cli-anything-obsidian vault create "Projekte/neues-projekt.md" --content "# Neues Projekt"

# Eine Notiz aktualisieren (überschreiben)
cli-anything-obsidian vault update "Projekte/neues-projekt.md" --content "# Aktualisierter Inhalt"

# An eine Notiz anhängen
cli-anything-obsidian vault append "Projekte/neues-projekt.md" --content "\n## Neuer Abschnitt"

Suche

# Einfache Textsuche (GET /search/simple/)
cli-anything-obsidian search simple "Besprechungsnotizen"

# Dataview DQL-Abfrage — Standard --type dql, gesendet als
# application/vnd.olrapi.dataview.dql+txt
cli-anything-obsidian search query 'TABLE file.link FROM "Projekte"'

# JsonLogic-Abfrage — application/vnd.olrapi.jsonlogic+json
cli-anything-obsidian search query --type jsonlogic \
  '{"==":[{"var":"frontmatter.status"},"aktiv"]}'

Befehle

# Verfügbare Befehle auflisten
cli-anything-obsidian command list

# Einen Befehl anhand seiner ID ausführen
cli-anything-obsidian command execute "editor:toggle-bold"

Interaktive REPL-Sitzung

Starten Sie eine interaktive Sitzung für den explorativen Einsatz.

cli-anything-obsidian
# Befehle interaktiv eingeben
# 'help' verwenden, um verfügbare Befehle anzuzeigen

API-Key-Konfiguration

# Über Flag
cli-anything-obsidian --api-key YOUR_KEY vault list

# Über Umgebungsvariable (für Agenten empfohlen)
export OBSIDIAN_API_KEY=YOUR_KEY
cli-anything-obsidian vault list

Zustandsverwaltung

Das CLI verwaltet einen leichten Sitzungszustand:

• API-Key: Konfigurierbar über --api-key oder die Umgebungsvariable OBSIDIAN_API_KEY
• Host-URL: Standardmäßig https://localhost:27124; konfigurierbar über --host

Ausgabeformate

Alle Befehle unterstützen zwei Ausgabemodi:

• Für Menschen lesbar (Standard): Tabellen, Farben, formatierter Text
• Maschinenlesbar (--json-Flag): Strukturiertes JSON für Agenten

# Ausgabe für Menschen
cli-anything-obsidian vault list

# JSON-Ausgabe für Agenten
cli-anything-obsidian --json vault list

Für KI-Agenten

Bei programmatischer Nutzung dieses CLI:

1. Immer das --json-Flag verwenden für parsebare Ausgabe
2. Rückgabecodes prüfen – 0 für Erfolg, nicht null für Fehler
3. stderr parsen für Fehlermeldungen bei Misserfolg
4. Umgebungsvariable OBSIDIAN_API_KEY setzen, um die Übergabe von --api-key bei jedem Aufruf zu vermeiden
5. Sicherstellen, dass Obsidian läuft, mit server status vor anderen Befehlen

Weitere Informationen

• Vollständige Dokumentation: Siehe README.md im Paket
• Testabdeckung: Siehe TEST.md im Paket
• Methodik: Siehe HARNESS.md im cli-anything-plugin

Version

1.1.0