Interface de ligne de commande Obsidian

Utilisez la CLI obsidian pour interagir avec une instance Obsidian en cours d'exécution. Nécessite qu'Obsidian soit ouvert.

Référence des commandes

Exécutez obsidian help pour voir toutes les commandes disponibles. C'est toujours à jour. Documentation complète : https://help.obsidian.md/cli

Syntaxe

Les paramètres prennent une valeur avec =. Mettez entre guillemets les valeurs contenant des espaces :

obsidian create name="My Note" content="Hello world"

Les flags sont des commutateurs booléens sans valeur :

obsidian create name="My Note" silent overwrite

Pour du contenu multiligne, utilisez \n pour une nouvelle ligne et \t pour une tabulation.

Ciblage de fichiers

De nombreuses commandes acceptent file ou path pour cibler un fichier. Sans l'un ou l'autre, le fichier actif est utilisé.

file=<name> — se résout comme un wikilink (nom seulement, pas de chemin ni d'extension nécessaire)
path=<path> — chemin exact depuis la racine du coffre-fort, p. ex. folder/note.md

Ciblage du coffre-fort

Par défaut, les commandes ciblent le coffre-fort le plus récemment actif. Utilisez vault=<name> comme premier paramètre pour cibler un coffre-fort spécifique :

obsidian vault="My Vault" search query="test"

Schémas courants

obsidian read file="My Note"
obsidian create name="New Note" content="# Hello" template="Template" silent
obsidian append file="My Note" content="New line"
obsidian search query="search term" limit=10
obsidian daily:read
obsidian daily:append content="- [ ] New task"
obsidian property:set name="status" value="done" file="My Note"
obsidian tasks daily todo
obsidian tags sort=count counts
obsidian backlinks file="My Note"

Utilisez --copy sur n'importe quelle commande pour copier la sortie vers le presse-papiers. Utilisez silent pour empêcher l'ouverture des fichiers. Utilisez total sur les commandes de liste pour obtenir un décompte.

Développement de plugins

Cycle développement/test

Après avoir apporté des modifications de code à un plugin ou un thème, suivez ce flux de travail :

Rechargez le plugin pour récupérer les modifications :
```
obsidian plugin:reload id=my-plugin
```
Vérifiez les erreurs — si des erreurs apparaissent, corrigez et répétez à partir de l'étape 1 :
```
obsidian dev:errors
```

Vérifiez visuellement avec une capture d'écran ou une inspection du DOM :

obsidian dev:screenshot path=screenshot.png
obsidian dev:dom selector=".workspace-leaf" text

Vérifiez la sortie de la console pour les avertissements ou les journaux inattendus :
```
obsidian dev:console level=error
```

Commandes développeur supplémentaires

Exécutez du JavaScript dans le contexte de l'application :

obsidian eval code="app.vault.getFiles().length"

Inspectez les valeurs CSS :

obsidian dev:css selector=".workspace-leaf" prop=background-color

Basculez l'émulation mobile :

obsidian dev:mobile on

Exécutez obsidian help pour voir des commandes développeur supplémentaires incluant les contrôles CDP et débogueur.

obsidian-cli