cli-anything-siyuan

Que fait cli-anything-siyuan ?

Interface en ligne de commande pour SiYuan (思源笔记), une application de prise de notes et gestion des connaissances locale.

Cette CLI se connecte à un noyau SiYuan en cours d'exécution via son API HTTP (http://127.0.0.1:6806) et offre un accès structuré aux notebooks, documents, blocs, recherche et exportation.

Prérequis

• SiYuan doit être en cours d'exécution (Paramètres → À propos affiche le jeton API)
• Python 3.10+
• Installation : pip install cli-anything-siyuan ou pip install -e . depuis agent-harness/

Groupes de commandes

notebook — Gestion des notebooks

Sous-commande	Description
list	Lister tous les notebooks
create <nom>	Créer un nouveau notebook
rename <id> <nom>	Renommer un notebook
remove <id>	Supprimer un notebook
open <id>	Ouvrir un notebook

doc — Gestion des documents

Sous-commande	Description
create <notebook> <chemin> [--md "contenu"]	Créer un document
list <notebook> [chemin]	Lister les documents
tree <notebook> [--path / --depth]	Afficher l'arborescence des documents
get <id>	Obtenir le chemin d'un document par son ID
rename <id> <titre>	Renommer un document
remove <id>	Supprimer un document

block — Opérations sur les blocs

Sous-commande	Description
insert <données> [--previous / --parent]	Insérer un bloc
update <id> <données>	Mettre à jour un bloc
delete <id>	Supprimer un bloc
get <id>	Obtenir le source kramdown du bloc
children <id>	Obtenir les blocs enfants

Autres commandes

Commande	Description
sql <requête>	Exécuter du SQL sur la base de blocs
search <requête>	Recherche plein texte dans les blocs
export md <doc-id>	Exporter un document au format Markdown
tag list	Lister toutes les étiquettes
version	Afficher la version du noyau SiYuan
status	Afficher le statut de la connexion et de la session
repl	Démarrer un REPL interactif

Recommandations pour l'agent

• Utilisez toujours --json pour une sortie lisible par machine
• Recherche avancée : utilisez sql "SELECT * FROM blocks WHERE content LIKE '%mot-clé%'" pour un accès au niveau SQL
• Les IDs de documents ressemblent à 20210817205410-2kvfpfn (basés sur un timestamp)
• Le jeton API se trouve dans Paramètres SiYuan → À propos
• Connexion par défaut : http://127.0.0.1:6806

Exemples

# Lister les notebooks (JSON)
cli-anything-siyuan --json notebook list

# Créer un document avec Markdown (drapeau --md, attention à l'échappement shell)
cli-anything-siyuan doc create nb1 /projects/new --md "## Titre\n\nContenu"

# Créer un document — pipé Markdown via stdin (évite l'échappement shell)
# PowerShell here-string (littéral, aucun échappement nécessaire) :
@'
## Titre
Contenu avec `backticks` et (parenthèses) et "guillemets"
'@ | cli-anything-siyuan doc create nb1 /projects/new --md -

# Bash heredoc :
# cat <<'EOF' | cli-anything-siyuan doc create nb1 /projects/new --md -
# ## Titre
# Contenu avec `backticks` et (parenthèses)
# EOF

# Recherche SQL
cli-anything-siyuan sql "SELECT id, content FROM blocks WHERE content LIKE '%réunion%' LIMIT 5"

# Exportation
cli-anything-siyuan export md doc123

# Démarrer le REPL
cli-anything-siyuan

Gestion des erreurs

• Erreurs de connexion : vérifiez que SiYuan est en cours d'exécution et que le jeton API est correct
• Erreurs API : renvoyées sous la forme {"code": N, "msg": "..."} — consultez le champ message
• Erreurs d'authentification : vérifiez le jeton dans ~/.siyuan-cli.json ou la variable d'environnement SIYUAN_TOKEN