cli-anything-obsidian
Command-line interface for Obsidian — Knowledge management and note-taking via Obsidian Local REST API. Designed for AI agents and power users who need to manage notes, search the vault, and execute commands without the GUI.
By hkuds · 725 installs
npx skills add hkuds/cli-anything --skill cli-anything-obsidian
Source repository · Upstream listing
cli anything obsidian
Knowledge management and note taking via the Obsidian Local REST API. Designed for AI agents and power users who need to manage notes, search the vault, and execute commands without the GUI.
Installation
This CLI is installed as part of the cli anything obsidian package:
Prerequisites:
Python 3.10+
Obsidian must be installed and running with the [Local REST API plugin](https://github.com/coddingtonbear/obsidian local rest api) enabled
Usage
Basic Commands
REPL Mode
When invoked without a subcommand, the CLI enters an interactive REPL session:
Command Groups
Vault
Vault file management commands.
Command Description
list List files in the vault or a subdirectory
read Read the content of a note
create Create a new note
update Overwrite an existing note
delete Delete a note from the vault
append Append content to an existing note
Search
Vault search commands.
Command Description
query Search using Obsidian query syntax
simple Plain text search across the vault
Note
Active note commands.
Command Description
active Get the currently active note in Obsidian
open Open a note in the Obsidian editor
Command
Obsidian command palette commands.
Command Description
list List all available Obsidian commands
execute Execute a command by its ID
Server
Server status and info commands.
Command Description
status Check if the Obsidian Local REST API is running
Session
Session state commands.
Command Description
status Show current session state
Examples
List and Read Notes
Create and Update Notes
Search
Commands
Interactive REPL Session
Start an interactive session for exploratory use.
API Key Configuration
State Management
The CLI maintains lightweight session state:
API key : Configurable via api key or OBSIDIAN API KEY environment variable
Host URL : Defaults to https://localhost:27124 ; configurable via host
Output Formats
All commands support dual output modes:
Human readable (default): Tables, colors, formatted text
Machine readable ( json flag): Structured JSON for agent consumption
For AI Agents
When using this CLI programmatically:
1. Always use json flag for parseable output
2. Check return codes 0 for success, non zero for errors
3. Parse stderr for error messages on failure
4. Set OBSIDIAN API KEY environment variable to avoid passing api key on every call
5. Verify Obsidian is running with server status before other commands
More Information
Full documentation: See README.md in the package
Test coverage: See TEST.md in the package
Methodology: See HARNESS.md in the cli anything plugin
Version
1.1.0