Notre avis

Cette compétence permet d'interagir avec un coffre Obsidian via l'interface en ligne de commande, pour lire, créer, chercher et gérer des notes, propriétés, tâches et liens retour, ainsi que développer et déboguer des plugins et thèmes.

Points forts

Manipule directement les notes et métadonnées Obsidian depuis la ligne de commande.
Prend en charge à la fois les opérations de base sur les notes et les workflows avancés de développement de plugins.
Permet de cibler des coffres et fichiers spécifiques avec des noms flexibles.
Inclut des commandes développeur pour recharger les plugins, inspecter le DOM et exécuter du JavaScript.

Limites

Nécessite qu'Obsidian soit ouvert avec l'API REST locale activée.
La CLI est en lecture-écriture, donc une perte accidentelle de données est possible en cas de mauvaise utilisation.
Certaines commandes peuvent dépendre de plugins spécifiques ou d'une configuration supplémentaire.

Quand l'utiliser

Utilisez lorsque vous avez besoin de gérer des notes, rechercher du contenu ou développer des plugins Obsidian de manière programmatique ou via un agent IA sans ouvrir l'interface graphique.

Quand l'éviter

Ne l'utilisez pas si Obsidian n'est pas en cours d'exécution ou si l'utilisateur préfère une gestion graphique des notes, car la CLI offre une représentation limitée du coffre.

Exemples

Read a note

Read the content of my Obsidian note 'Meeting Notes' and summarize it.

Search vault for a term

Search my Obsidian vault for notes containing 'project roadmap' and list the file names.

Plugin development: reload and check errors

I just updated my Obsidian plugin 'my-plugin', reload it and check for any errors.

name: obsidian-cli description: Interact with Obsidian vaults using the Obsidian CLI to read, create, search, and manage notes, tasks, properties, and more. Also supports plugin and theme development with commands to reload plugins, run JavaScript, capture errors, take screenshots, and inspect the DOM. Use when the user asks to interact with their Obsidian vault, manage notes, search vault content, perform vault operations from the command line, or develop and debug Obsidian plugins and themes.

Obsidian CLI

Use the obsidian CLI to interact with a running Obsidian instance. Requires Obsidian to be open.

Command reference

Run obsidian help to see all available commands. This is always up to date. Full docs: https://help.obsidian.md/cli

Syntax

Parameters take a value with =. Quote values with spaces:

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

Flags are boolean switches with no value:

obsidian create name="My Note" silent overwrite

For multiline content use \n for newline and \t for tab.

File targeting

Many commands accept file or path to target a file. Without either, the active file is used.

file=<name> — resolves like a wikilink (name only, no path or extension needed)
path=<path> — exact path from vault root, e.g. folder/note.md

Vault targeting

Commands target the most recently focused vault by default. Use vault=<name> as the first parameter to target a specific vault:

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

Common patterns

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"

Use --copy on any command to copy output to clipboard. Use silent to prevent files from opening. Use total on list commands to get a count.

Plugin development

Develop/test cycle

After making code changes to a plugin or theme, follow this workflow:

Reload the plugin to pick up changes:
```
obsidian plugin:reload id=my-plugin
```
Check for errors — if errors appear, fix and repeat from step 1:
```
obsidian dev:errors
```

Verify visually with a screenshot or DOM inspection:

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

Check console output for warnings or unexpected logs:
```
obsidian dev:console level=error
```

Additional developer commands

Run JavaScript in the app context:

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

Inspect CSS values:

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

Toggle mobile emulation:

obsidian dev:mobile on

Run obsidian help to see additional developer commands including CDP and debugger controls.

Obsidian CLI - Gestion de coffres-forts

Recommandé pour