Guide · Agent skill
How to use the Obsidian CLI Vault Control agent skill
Updated · written with AI from the project's own documentation and checked against our catalogue data
The obsidian-cli skill lets an AI agent work with a notes vault that is already open in the Obsidian desktop app, using Obsidian's own command-line tool. This guide explains what the skill does, how to install it, how to ask for things in plain language, and what to watch out for. By the end you will be able to file, search and update notes through your agent, and know which commands can change your content.
Quick start
- 1Install Obsidian and open your vault. Install the Obsidian desktop app and keep it open with the vault you want to work with.
- 2Confirm the CLI works. Run obsidian help in a terminal. If it lists commands, the CLI is available.
- 3Download and unzip the skill. Download the ZIP from this page and unzip it into ~/.claude/skills/ or your project's .claude/skills/ folder.
- 4Or upload the skill in the Claude apps. In the Claude apps, go to Settings → Capabilities → Skills and upload the skill.
- 5Ask for a vault task in plain language. Request something specific, such as searching for a topic or adding a task to today's daily note.
- 6Review the result. Check the note or output the agent produced, especially after any write or overwrite command.
What is an agent skill and what does this one do?
An agent skill is a folder containing a SKILL.md file with instructions that an AI agent loads when a request matches the skill's description. This skill is written for Obsidian, a note-taking app that stores notes as files in a folder called a vault.
With the skill installed, the agent can read notes, create notes, append text, search the vault, manage tasks, properties and tags, check backlinks, and work with daily notes. The agent does this by running the obsidian command in your terminal, so the app must be open.
Install the obsidian-cli skill
Download the ZIP for this skill from this page and unzip it. You can put the skill in one of two places. For all your projects, place the unzipped skill folder in ~/.claude/skills/. For a single project, place it in that project's .claude/skills/ folder.
You can also upload the skill in the Claude apps under Settings → Capabilities → Skills.
Before you rely on the skill, confirm the Obsidian CLI works by running obsidian help in a terminal. If the command is not found, the skill cannot run its commands.
- Requirement: Obsidian desktop app installed and open.
- Requirement: Obsidian CLI available on the command line.
obsidian helpTrigger the skill with natural requests
You do not need to name the skill. The skill's description covers requests to interact with your vault, manage notes, search vault content, run vault operations from the command line, or develop and debug plugins and themes. Ask in plain language and mention Obsidian or your vault so the agent knows where to look.
Good requests name the note or the action. For example, ask the agent to find notes that mention a topic, add a task to today's daily note, or set a status property on a named note.
- Search my Obsidian vault for notes that mention invoices and list the top 10.
- Add the task 'call the accountant' to my daily note.
- Set the status property to done on my Project Plan note.
- Show me the backlinks for my Reading List note.
- List the tags in my vault sorted by how often they are used.
Understand how the commands are written
Parameters take a value with an equals sign, and values with spaces are quoted. Flags are switches with no value. Many commands accept file (resolves like a wikilink, name only) or path (exact path from the vault root, such as folder/note.md). If you omit both, the active file is used. Commands target the most recently focused vault unless you give vault= first.
You will rarely type these yourself, but reading them helps you check what the agent plans to run.
- Use \n for a new line and \t for a tab in multiline content.
- Add --copy to any command to copy its output to the clipboard.
- Add silent to stop files from opening.
- Add total to list commands to get a count.
obsidian create name="My Note" silent overwrite
obsidian vault="My Vault" search query="test"Use the skill for plugin and theme development
If you build Obsidian plugins or themes, the skill describes a develop-and-test loop. After a code change, the agent reloads the plugin, checks for errors, and then verifies the result with a screenshot or DOM inspection. It can also read console output for warnings.
The skill also covers running JavaScript in the app with eval, reading CSS values, and toggling mobile emulation. Run obsidian help to see further developer commands, including CDP and debugger controls, which the source does not describe in detail.
- Reload a plugin with plugin:reload id=your-plugin-id.
- Check errors with dev:errors.
- Capture a screenshot with dev:screenshot.
- Read errors in the console with dev:console level=error.
obsidian plugin:reload id=my-plugin
obsidian dev:errors
obsidian dev:screenshot path=screenshot.pngSafety notes before you run it
Commands write directly to your notes. The overwrite flag can replace existing content, so use a test vault or back up important notes before letting an agent edit them. Review what the agent proposes when the vault matters to you.
The skill runs scripts, so treat it like any code you install. It does not use the network, according to its listing. The eval command runs arbitrary JavaScript inside the app and can read or change anything the app can access. Do not use it in environments where that is unacceptable.
- Keep a backup or use a test vault for first runs.
- Avoid the overwrite flag unless you intend to replace content.
- Skip eval in sensitive environments.
Tips for getting reliable results
Mention the vault name if you have more than one open, since commands otherwise use the most recently focused vault. Name the note precisely, or give its path, so the agent does not act on the active file by accident.
If a command behaves unexpectedly, ask the agent to run obsidian help to see the current command list. The skill itself points to the official help page for full documentation.
- Name the vault when you have several.
- Give exact note names or paths.
- Ask the agent to show the command before running it if you want to review it.
What people use it for
- Search a vault for notes on a topic and return a limited list of results.
- Append a new line or task to today's daily note from the terminal or chat.
- Set a status property on a named note to track project progress.
- Find backlinks to a note before renaming or reorganising it.
- Reload a plugin, check errors and take a screenshot while developing an Obsidian plugin or theme.
Frequently asked questions
How do I install the obsidian-cli skill?
Download the ZIP from this page and unzip it into ~/.claude/skills/ for all projects, or into a project's .claude/skills/ folder for one project. You can also upload it in the Claude apps under Settings → Capabilities → Skills.
What do I need to run the obsidian-cli skill?
You need the Obsidian desktop app installed and open, and the Obsidian CLI available on the command line. Run obsidian help to confirm the CLI works. The skill does not work if Obsidian is closed.
Is the obsidian-cli skill free?
The skill is listed under the MIT licence. The source does not describe pricing for Obsidian itself, so check Obsidian's own terms for that.
Does the skill need an internet connection?
The listing says the skill does not use the network. It does run scripts, and it works with the vault open on your computer.
Can the agent accidentally delete or overwrite my notes?
Commands write directly to notes, and the overwrite flag can replace existing content. Use a test vault or backups for first runs, and avoid overwrite unless you intend it.
Do I need this skill if I only edit files directly?
No. The source says Obsidian is not needed if you work on files directly. This skill is for users who want an agent to interact with the open Obsidian app.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
This skill suits Obsidian users who want an AI agent to file, search or update notes from the terminal or chat, and plugin or theme developers who want to reload, test and debug inside Obsidian. It is a poor fit if you do not run Obsidian, want unreviewed edits to an important vault, or cannot allow arbitrary JavaScript through eval, in which case work on files directly instead.
Download the skill