Cli Anything Obsidian

by hkuds34f519533bc1No license51K starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 2 weeks ago

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.

Instructions onlyProductivity & Workflow
AI-generated overview

Command-line interface for managing Obsidian notes, searching vaults, and running Obsidian commands via the Local REST API.

What it does
Provides a CLI for Obsidian that lists, reads, creates, updates, appends to, and deletes vault notes, and searches the vault with plain text, Dataview DQL, or JsonLogic queries. It can also read or open the active note, list and execute Obsidian command palette commands, and check server and session status. Output is human-readable by default or structured JSON with the --json flag, and an interactive REPL is available.
When to use it
Use it when an agent or power user needs to work with an Obsidian vault without the GUI, such as reading or writing notes, searching note content, or triggering Obsidian commands. It suits scripted or agent-driven knowledge management where JSON output and return codes matter.
Requirements
Requires Python 3.10+ and the cli-anything-obsidian package installed via pip. Obsidian must be installed and running with the Local REST API plugin enabled. An API key is supplied via the --api-key flag or the OBSIDIAN_API_KEY environment variable, and the host defaults to and is configurable with --host. Network access to the local REST API is needed. No scripts ship with the skill; it is instructions only.

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:

bash
pip install cli-anything-obsidian

Prerequisites:

Usage

Basic Commands

bash
# Show helpcli-anything-obsidian --help
# Start interactive REPL modecli-anything-obsidian
# List vault filescli-anything-obsidian vault list
# Run with JSON output (for agent consumption)cli-anything-obsidian --json vault list

REPL Mode

When invoked without a subcommand, the CLI enters an interactive REPL session:

bash
cli-anything-obsidian# Enter commands interactively with tab-completion and history

Command Groups

Vault

Vault file management commands.

CommandDescription
listList files in the vault or a subdirectory
readRead the content of a note
createCreate a new note
updateOverwrite an existing note
deleteDelete a note from the vault
appendAppend content to an existing note

Search

Vault search commands.

CommandDescription
querySearch using Obsidian query syntax
simplePlain text search across the vault

Note

Active note commands.

CommandDescription
activeGet the currently active note in Obsidian
openOpen a note in the Obsidian editor

Command

Obsidian command palette commands.

CommandDescription
listList all available Obsidian commands
executeExecute a command by its ID

Server

Server status and info commands.

CommandDescription
statusCheck if the Obsidian Local REST API is running

Session

Session state commands.

CommandDescription
statusShow current session state

Examples

List and Read Notes

bash
# List all vault filescli-anything-obsidian vault list
# List files in a subdirectorycli-anything-obsidian vault list "Daily Notes"
# Read a notecli-anything-obsidian vault read "Projects/my-project.md"

Create and Update Notes

bash
# Create a new notecli-anything-obsidian vault create "Projects/new-project.md" --content "# New Project"
# Update (overwrite) a notecli-anything-obsidian vault update "Projects/new-project.md" --content "# Updated Content"
# Append to a notecli-anything-obsidian vault append "Projects/new-project.md" --content "\n## New Section"

Search

bash
# Plain text search (GET /search/simple/)cli-anything-obsidian search simple "meeting notes"
# Dataview DQL query — default --type dql, sent as# application/vnd.olrapi.dataview.dql+txtcli-anything-obsidian search query 'TABLE file.link FROM "Projects"'
# JsonLogic query — application/vnd.olrapi.jsonlogic+jsoncli-anything-obsidian search query --type jsonlogic \  '{"==":[{"var":"frontmatter.status"},"active"]}'

Commands

bash
# List available commandscli-anything-obsidian command list
# Execute a command by IDcli-anything-obsidian command execute "editor:toggle-bold"

Interactive REPL Session

Start an interactive session for exploratory use.

bash
cli-anything-obsidian# Enter commands interactively# Use 'help' to see available commands

API Key Configuration

bash
# Via flagcli-anything-obsidian --api-key YOUR_KEY vault list
# Via environment variable (recommended for agents)export OBSIDIAN_API_KEY=YOUR_KEYcli-anything-obsidian vault list

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
bash
# Human outputcli-anything-obsidian vault list
# JSON output for agentscli-anything-obsidian --json vault list

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

Source and attribution

Source:hkuds/cli-anythinginskills/cli-anything-obsidianat commit34f5195

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal

More from hkuds/cli-anything

Cli Anything Zoom

hkuds

Command-line harness for managing Zoom meetings, participants, and cloud recordings through the Zoom REST API.

Productivity & Workflow51Kupdated 2 weeks ago

Cli Anything Novita

hkuds

Documents a command-line client for the Novita AI API, offering chat, streaming, model listing, session and config commands.

Software Development51Kupdated 2 weeks ago

Cli Anything Zotero

hkuds

Agent-native CLI harness for inspecting and operating a local Zotero desktop library.

Research & Analysis51Kupdated 2 weeks ago

Cli Anything Wiremock

hkuds

CLI harness for administering a WireMock HTTP mock server via its Admin REST API.

Software Development51Kupdated 2 weeks ago

Cli Anything Slay The Spire Ii

hkuds

Controls the Slay the Spire 2 game through a local bridge mod HTTP API, reading state and sending actions.

Other51Kupdated 2 weeks ago

Cli Anything Shotcut

hkuds

Command-line interface for creating and editing Shotcut video projects and rendering them without a GUI.

Design & Creative51Kupdated 2 weeks ago

More in Productivity & Workflow

Dd Meeting Prep

anthropics

Featured

Prepares question lists, benchmarks and red flags for due diligence meetings such as management presentations and expert calls.

Productivity & Workflow39Kupdated 2 weeks ago

Dd Checklist

anthropics

Featured

Builds and tracks sector-tailored due diligence checklists with workstreams, status tracking and red flag escalation.

Productivity & Workflow39Kupdated 2 weeks ago

Deal Tracker

anthropics

Featured

Tracks live M&A deals with milestones, deadlines, action items and weekly pipeline reviews.

Productivity & Workflow39Kupdated 2 weeks ago

Client Review

anthropics

Featured

Prepares client review meetings with portfolio performance, allocation analysis, talking points, and action items.

Productivity & Workflow39Kupdated 2 weeks ago

Morning Note

anthropics

Featured

Drafts concise morning meeting notes on overnight developments, trade ideas and key events for coverage stocks.

Productivity & Workflow39Kupdated 2 weeks ago

Notion Spec To Implementation

openai

Featured

Turns Notion specs into implementation plans, linked tasks, and progress updates inside Notion.

Productivity & Workflow27Kupdated 4 weeks ago