obsidian-rs-cli-0.3.0 is not a library.
obsidian.rs
A collection of tools for working with Obsidian vaults, written in Rust.
| Crate | Description |
|---|---|
obsidian-rs-core |
Core library — the foundation the other tools build on |
obsidian-rs-cli |
Command-line tool for querying and managing vaults |
obsidian-rs-mcp |
MCP server so agents can interact with your vault |
obsidian-rs-lsp |
A language server for vault editing in your IDE |
CLI
Install with Cargo:
The obsidian binary resolves your vault automatically — it walks up from the current directory looking for a folder containing .obsidian/. You can also set OBSIDIAN_VAULT or pass --vault <PATH> explicitly.
Commands
obsidian search Search for notes
obsidian note Work with individual notes
resolve Resolve a note by path, ID, or alias
list List all notes
read Read contents or frontmatter
write Write a new note
backlinks Find notes that link to a given note
merge Merge multiple notes into one
patch Replace one exact string in a note's content
rename Rename a note and update all backlinks
update Update frontmatter metadata fields
obsidian tags Work with tags
list List all tags used across the vault
search Find all occurrences of given tags
obsidian check Vault health check (broken links, duplicate IDs/aliases)
Examples
# Find all notes tagged #project that mention "rust"
# Find notes matching a regex pattern in their content
# List notes sorted by last modified
# Read a note's frontmatter as JSON
# Rename a note and automatically update every backlink
# Find all notes that link to a given note
# List all tags, sorted alphabetically
# Check the vault for broken links and duplicate IDs
MCP Server
Install and register with Claude in one step:
Tools exposed
| Tool | Description |
|---|---|
check_vault |
Report duplicate IDs, duplicate aliases, and broken links in the vault |
list_notes |
List all notes in the vault |
read_note |
Read the body and frontmatter of a note |
write_note |
Write a new note |
patch_note |
Replace one exact string in a note |
update_note |
Update frontmatter fields of a note |
search_notes |
Search for notes with filters (tag, title, content, glob, regex) |
rename_note |
Rename a note and update all backlinks |
list_tags |
List all tags used in the vault |
search_tags |
Find all occurrences of given tags |
LSP Server
Install with Cargo:
The obsidian-lsp binary speaks stdio LSP and resolves the vault the same way as obsidian-mcp: --vault <PATH>, then OBSIDIAN_VAULT, then the nearest parent containing .obsidian/.
Current functionality:
- clean LSP initialization and shutdown
- full-document text sync for open buffers
- in-memory buffer shadowing through
obsidian_core::Vault::load_note()/unload_note() - diagnostics for broken links, duplicate IDs, and duplicate aliases across the vault
- hover on note links with basic target-note metadata
- document links for wiki and markdown note links, with resolve support
- references/backlinks for linked notes, or for the current note when the cursor is not on a link
- go-to definition for linked notes, including heading anchors and nested sub-anchors
- diagnostics clearing and refresh on open/change/close events
- completion for wiki links (
[[) and markdown links ([) with per-note variants: bare ID, bare title, alias override, and bare alias forms
Advanced editor features such as rename are not implemented yet.