cli-anything-siyuan

Was macht cli-anything-siyuan?

CLI-Werkzeug für SiYuan (思源笔记), eine lokale, datenschutzfreundliche Wissensmanagement- und Notizanwendung.

Diese CLI verbindet sich über die HTTP-API (http://127.0.0.1:6806) mit einem laufenden SiYuan-Kernel und bietet strukturierten Zugriff auf Notizbücher, Dokumente, Blöcke, Suche und Export.

Voraussetzungen

• SiYuan muss ausgeführt werden (Einstellungen → Über zeigt das API-Token)
• Python 3.10+
• Installation: pip install cli-anything-siyuan oder pip install -e . aus agent-harness/

Befehlsgruppen

notebook – Notizbuchverwaltung

Unterbefehl	Beschreibung
list	Alle Notizbücher auflisten
create <name>	Ein neues Notizbuch erstellen
rename <id> <name>	Ein Notizbuch umbenennen
remove <id>	Ein Notizbuch löschen
open <id>	Ein Notizbuch öffnen

doc – Dokumentenverwaltung

Unterbefehl	Beschreibung
create <notebook> <path> [--md "Inhalt"]	Ein Dokument erstellen
list <notebook> [path]	Dokumente auflisten
tree <notebook> [--path / --depth]	Dokumentbaum anzeigen
get <id>	Dokumentpfad anhand der ID abrufen
rename <id> <titel>	Ein Dokument umbenennen
remove <id>	Ein Dokument löschen

block – Blockoperationen

Unterbefehl	Beschreibung
insert <daten> [--previous / --parent]	Einen Block einfügen
update <id> <daten>	Einen Block aktualisieren
delete <id>	Einen Block löschen
get <id>	Kramdown-Quelle eines Blocks abrufen
children <id>	Unterblöcke abrufen

Weitere Befehle

Befehl	Beschreibung
sql <anweisung>	SQL auf der Blockdatenbank ausführen
search <abfrage>	Volltextsuche über alle Blöcke
export md <dok-id>	Dokument als Markdown exportieren
tag list	Alle Tags auflisten
version	SiYuan-Kernel-Version anzeigen
status	Verbindungs- und Sitzungsstatus anzeigen
repl	Interaktive REPL starten

Anleitung für den Agenten

• Verwenden Sie immer --json für maschinenlesbare Ausgaben
• Leistungsstarke Suche: Nutzen Sie sql "SELECT * FROM blocks WHERE content LIKE '%schlagwort%'" für SQL-Zugriff auf Blockebene
• Dokumenten-IDs sehen aus wie 20210817205410-2kvfpfn (zeitstempelbasiert)
• Das API-Token finden Sie in den SiYuan-Einstellungen → Über
• Standardverbindung: http://127.0.0.1:6806

Beispiele

# Notizbücher auflisten (JSON)
cli-anything-siyuan --json notebook list

# Ein Dokument mit Markdown erstellen (--md-Flag, Shell-Escaping beachten)
cli-anything-siyuan doc create nb1 /projects/new --md "## Titel\n\nInhalt"

# Ein Dokument erstellen – Markdown über stdin übergeben (vermeidet Shell-Escaping)
# PowerShell Here-String (wörtlich, kein Escaping nötig):
@'
## Titel
Inhalt mit `Backticks` und (Klammern) und "Anführungszeichen"
'@ | cli-anything-siyuan doc create nb1 /projects/new --md -

# Bash Here-Dokument:
# cat <<'EOF' | cli-anything-siyuan doc create nb1 /projects/new --md -
# ## Titel
# Inhalt mit `Backticks` und (Klammern)
# EOF

# SQL-Suche
cli-anything-siyuan sql "SELECT id, content FROM blocks WHERE content LIKE '%meeting%' LIMIT 5"

# Export
cli-anything-siyuan export md doc123

# REPL starten
cli-anything-siyuan

Fehlerbehandlung

• Verbindungsfehler: Überprüfen Sie, ob SiYuan läuft und das API-Token korrekt ist
• API-Fehler: Werden als {"code": N, "msg": "..."} zurückgegeben – prüfen Sie das Nachrichtenfeld
• Authentifizierungsfehler: Überprüfen Sie das Token in ~/.siyuan-cli.json oder der Umgebungsvariablen SIYUAN_TOKEN