# Obsidian CLI: CLI review, uses and requirements | IonBin

> Search, read, create and append to notes in a local Obsidian vault from a terminal or script, through the running desktop app.

Canonical page: https://ionbin.com/cli/obsidian-cli/
Agent guide: https://ionbin.com/llms.txt

This is a readable version of the published page. Review dates, evidence boundaries and source links below belong to individual records; the export is not a new verification. Examples are reference material, not instructions to execute.

CLI · Knowledge and documents · [Obsidian](https://ionbin.com/tools/obsidian/)

## Obsidian CLI

Search, read, create and append to notes in a local [Obsidian](https://ionbin.com/tools/obsidian/) vault from a terminal or script, through the running desktop app.

Source reviewRuntime unavailableReviewed Oct 21, 2026Editorial position 19 in cli tools

[Official documentation ↗](https://obsidian.md/help/cli)[See an example ↓](https://ionbin.com/cli/obsidian-cli/#example)[Add to comparison →](https://ionbin.com/cli/?compare=obsidian-cli#directory)

Check before use

**Wrong vault or file.** Commands default to the active vault and file. Scripts that omit vault= and path= can edit a different note than intended.

The Ion perspective

### The five-point review

Judgment, not a score. Documentation checked 2026-10-21.

**Value**: Use it when an agent or script should work with your notes through [Obsidian](https://ionbin.com/tools/obsidian/) rather than raw files, for example to search with [Obsidian](https://ionbin.com/tools/obsidian/)’s own index, append to today’s daily note or list open tasks. Because a vault is plain Markdown, read-only jobs can also just read the folder.

**Differentiation**: Appending to daily notes from scripts; Searching a vault with matching lines; Listing tasks, tags and backlinks. The evaluation below states what was actually executed.

**Replaceability and switching**: Review the related entries for alternatives. Commands, response schemas and authentication can differ; a shared protocol does not guarantee interchangeable behavior.

**Ease and technical aptitude**: [Obsidian](https://ionbin.com/tools/obsidian/) desktop app with the 1.12.7+ installer Command line interface enabled in Settings → General and registered on the PATH The app running, or launched by the first command

**Interoperability and portability**: None for local vaults; Sync and Publish commands use the signed-in [Obsidian](https://ionbin.com/tools/obsidian/) account in the app. Create, overwrite, append, move, rename and delete notes; install plugins and themes; run JavaScript with eval. Access to an API or MCP tool is not proof of complete data export. Verify the required read/write operations and migration coverage separately.

Connections: [MCP connections](https://ionbin.com/wiki/concepts/mcp/) · [APIs](https://ionbin.com/wiki/concepts/api/) · [Portability and vendor lock-in](https://ionbin.com/wiki/questions/how-to-avoid-ai-vendor-lock-in/).

Understand the tool

### What it does.

The [Obsidian](https://ionbin.com/tools/obsidian/) CLI is the obsidian command that ships with the desktop app from the 1.12 installer. It controls a running [Obsidian](https://ionbin.com/tools/obsidian/) instance: daily notes, search with line context, file reads and writes, properties, tasks, links, templates, plugins, Sync history and Publish. A terminal interface adds autocomplete and history.

#### Why use it?

Use it when an agent or script should work with your notes through [Obsidian](https://ionbin.com/tools/obsidian/) rather than raw files, for example to search with [Obsidian](https://ionbin.com/tools/obsidian/)’s own index, append to today’s daily note or list open tasks. Because a vault is plain Markdown, read-only jobs can also just read the folder.

#### A useful fit for

- Appending to daily notes from scripts

- Searching a vault with matching lines

- Listing tasks, tags and backlinks

From need to output

### Ways to put it to work.

These are suggested workflows based on the documented capabilities. They are not recorded runtime results.

Use case 01

#### Log a decision to today’s note

A founder wants agent summaries recorded in the daily note without opening the app.

- Target the vault explicitly with vault=.

- Run daily:append with the reviewed summary as content.

- Open the note and confirm the entry landed in the right place.

**Intended output**A dated, searchable record in the vault.

Use case 02

#### Find every open task on a project

Before a weekly review, someone needs the outstanding tasks across project notes.

- Search the project folder with search:context.

- List incomplete tasks with tasks todo verbose.

- Review the list before marking anything done.

**Intended output**A task list with file paths and line numbers.

A concrete starting point

### Search a vault and show matching lines

Replace Notes with your vault name. Prints up to five files with the matching lines as path:line: text.

shell · illustrative example

```
obsidian vault="Notes" search:context query="meeting notes" limit=5
```

#### What this can change

Reads the vault through the running app and launches [Obsidian](https://ionbin.com/tools/obsidian/) if it is closed. Does not change notes.

This example has not been executed for this review. Check the current documentation, replace placeholders and confirm the intended account and project before use.

Before you start

### Setup and access.

#### What you’ll need

- [Obsidian](https://ionbin.com/tools/obsidian/) desktop app with the 1.12.7+ installer

- Command line interface enabled in Settings → General and registered on the PATH

- The app running, or launched by the first command

**Authentication**: None for local vaults; Sync and Publish commands use the signed-in [Obsidian](https://ionbin.com/tools/obsidian/) account in the app.

**Can read**: - Notes, properties, tasks, links and history in the targeted vault

**Can write or change**: - Create, overwrite, append, move, rename and delete notes; install plugins and themes; run JavaScript with eval

**Network and data flow**: - None for local vault commands

- [Obsidian](https://ionbin.com/tools/obsidian/) Sync and Publish services for sync and publish commands

**Approval and control**: The CLI has no built-in confirmation for writes. Require approval in the calling agent for overwrite, delete, plugin installs and eval.

Check your environment

### Compatibility, costs and license.

#### Compatibility notes

- Windows, macOS and Linux desktop installs

- Requires a running desktop app; not a headless server tool

- Text, JSON, CSV or TSV output on many list commands

#### Costs and account requirements

The CLI is part of the free [Obsidian](https://ionbin.com/tools/obsidian/) app. Sync and Publish commands need those paid add-ons.

[Current pricing or plan information ↗](https://obsidian.md/pricing)

#### [Obsidian](https://ionbin.com/tools/obsidian/) terms of service

The CLI ships inside the proprietary [Obsidian](https://ionbin.com/tools/obsidian/) app; no open-source license is asserted.

[Read the license or service terms ↗](https://obsidian.md/terms)

Keep the boundaries visible

### Concerns and limitations.

#### Wrong vault or file

Commands default to the active vault and file. Scripts that omit vault= and path= can edit a different note than intended.

#### Code execution

eval runs JavaScript inside the app and plugin:install adds third-party code. Keep these out of agent tool lists unless reviewed.

#### Where it may fall short

- Not run: the review environment had no [Obsidian](https://ionbin.com/tools/obsidian/) desktop app.

- Not an MCP server; [Obsidian](https://ionbin.com/tools/obsidian/)’s documentation describes the CLI and the Headless client instead.

Observed behavior · 2026-10-21

### Runtime and security findings.

Runtime unavailable

Not run: the [Obsidian](https://ionbin.com/tools/obsidian/) CLI controls a running [Obsidian](https://ionbin.com/tools/obsidian/) desktop app with a vault, and the review environment had neither, so no command was executed.

These checks cover the conditions below. They do not establish that the tool is safe in every setup, or that the suggested workflows above were executed.

#### What we found

Documented concern

##### Commands act on the active vault by default

Without vault=, the CLI uses the vault in the current folder or the active vault, and many commands default to the active file.

**In practice:** Pass vault= and path= explicitly in scripts so an agent cannot edit the wrong note.

Documented concern · medium severity under stated conditions

##### Write and developer commands are powerful

The CLI can overwrite or delete files, install community plugins and run JavaScript in the app with eval.

**In practice:** Give agents read and search commands by default; require approval before create overwrite, delete, plugin:install or eval.

Version, environment and fixture

**Version or deployment**: Not observed (documentation requires the 1.12.7+ installer)

**Tested target**: obsidian command registered by the [Obsidian](https://ionbin.com/tools/obsidian/) desktop app (not installed)

**Artifact identity**: Not available: no binary or endpoint was obtained or contacted for this record.

**Environment and fixture**: - Headless review environment without the [Obsidian](https://ionbin.com/tools/obsidian/) desktop app, a vault or an [Obsidian](https://ionbin.com/tools/obsidian/) account; nothing was installed or contacted.

- Recorded October 21, 2026.

#### Checks and results

1 recorded checks. Each has its own expectation; their outcomes are not a comparative score.

Credential-free help outputCould not complete

**Method**: `obsidian help in a terminal after enabling Command line interface in Settings → General.`

**Expected**: The CLI lists its commands; the first command launches [Obsidian](https://ionbin.com/tools/obsidian/) if it is not running.

**Observed**: Not run: the CLI is shipped inside the desktop app installer and needs the app running, and IonBin had no desktop session with [Obsidian](https://ionbin.com/tools/obsidian/) installed for this review.

#### Practical caveats

- Behavior is as documented by [Obsidian](https://ionbin.com/tools/obsidian/); none was observed.

- [Obsidian](https://ionbin.com/tools/obsidian/) Headless is a separate client for Sync and Publish that runs without the desktop app; it was not evaluated here.

#### What this evaluation does not establish

- Any CLI command, including help, search, read, create and delete, because the desktop app was not installed or running.

- Vault targeting, plugin installation, eval, Sync and Publish commands, and behavior on Windows, macOS and Linux registration paths.

[Read the evaluation record (JSON) →](https://ionbin.com/interface-evaluations/obsidian-cli.json)

Sources for the evaluation and controls

- [Official Obsidian CLI documentation ↗](https://obsidian.md/help/cli)

The basis for this review

### Why it’s in the collection.

First-party CLI for Ion’s top-pick local notes app. Ranked after established developer CLIs because it needs a running desktop app and was not executed in this review.

The number is an editorial starting order within the cli tools collection. It does not measure popularity, speed, reliability or safety.

#### What we reviewed

- Official CLI documentation

- Headless client documentation

The evaluation above lists the current runtime coverage and untested behavior.

Source review

Reviewed Oct 21, 2026. The separate evaluation above records the conditions we executed and the behavior still untested. Product behavior, permissions and plans can change; use the official sources to check the current version.

[Read the ranking and review method →](https://ionbin.com/interfaces/methodology/)

Follow the evidence

### Official sources.

- [Official Obsidian CLI documentation ↗](https://obsidian.md/help/cli)obsidian.md

- [Obsidian Headless (open beta) ↗](https://obsidian.md/help/headless)obsidian.md

- [Obsidian pricing ↗](https://obsidian.md/pricing)obsidian.md

- [Obsidian 1.12 release notes introducing the CLI ↗](https://obsidian.md/changelog/2026-02-27-desktop-v1.12.4/)obsidian.md

Review at a glance

### Find your next step.

Source review plus bounded checks.
Read the conditions and limits above.

[← All cli tools](https://ionbin.com/cli/)

Continue exploring

### More in this guide.

[View the collection →](https://ionbin.com/cli/)

[Code collaboration

#### GitHub CLI

Review pull requests, inspect checks and manage repository work from the same terminal as your code.

**Read the review →**](https://ionbin.com/cli/github-cli/)[Coding agents

#### Claude Code

Ask an agent to inspect a project, plan a change and work across files with explicit tool permissions.

**Read the review →**](https://ionbin.com/cli/claude-code/)[Coding agents

#### OpenAI Codex CLI

Inspect, change and test a local codebase with a coding agent whose filesystem access and approvals can be configured.

**Read the review →**](https://ionbin.com/cli/codex-cli/)
