A comprehensive command-line interface for Obsidian that enables full control over vaults, notes, and system settings directly from the terminal.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install obsidian-official-cli
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install obsidian-official-cli using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Obsidian Official CLI?
The Obsidian CLI is the official terminal-based tool designed for developers and power users who want to interact with their knowledge base without leaving the command line. It bridges the gap between terminal workflows and the Obsidian application, allowing for seamless note creation, vault navigation, and even advanced debugging.
As a powerful addition to the Openclaw Skills ecosystem, this tool enables complex automation and scripting for your personal knowledge management system. It requires Obsidian 1.12+ and a Catalyst license, providing a robust interface for everything from basic file operations to advanced plugin management and developer-level console access.
Obsidian Official CLI Use Cases
- Automating the creation of daily notes or complex project structures through shell scripts.
- Performing bulk searches or deep link analysis (orphans, unresolved links) across large vaults.
- Managing tasks and toggling completion status across different files without opening the GUI.
- Developing and debugging Obsidian plugins using integrated developer console commands and CSS inspection.
- Integrating your personal knowledge base into CI/CD or shell-based productivity environments.
How Obsidian Official CLI Works
- Ensure the Obsidian application (v1.12+) is running and the CLI is enabled in the application settings.
- Execute commands using the obsidian prefix followed by specific actions like file, search, or create.
- Target specific vaults using the vault="Vault Name" parameter or work with the active file by default.
- Utilize specific flags and parameters to refine outputs, such as using --copy for clipboard integration or format=json for programmatic data processing.
- Leverage the interactive TUI mode for a rich, terminal-based experience featuring autocomplete and command history.
Obsidian Official CLI Setup
To get started with this skill, ensure you have Obsidian 1.12 or higher and a Catalyst license. Follow these steps:
- Open Obsidian and navigate to Settings → General → Command line interface.
- Click Enable and follow the prompt to register the
obsidiancommand. - Restart your terminal or source your profile (e.g.,
source ~/ .zprofileon macOS). - Verify the setup by running:
obsidian version
Obsidian Official CLI Data Schema & Taxonomy
The CLI interacts directly with your vault structure and provides metadata in various formats. Below is how the skill organizes and accesses data:
| Entity | Identification | Metadata Accessible |
|---|---|---|
| File | file= |
Name, path, content, word count, properties |
| Folder | folder= |
Path, file list, folder hierarchy |
| Task | ref="file:line" | Status, content, location, completion state |
| Property | name= |
Value, type (text, list, number), frontmatter location |
| Plugin | id= |
Status (enabled/disabled), version, author info |
Obsidian Official CLI Advanced Features
- TUI Mode: An interactive terminal interface with autocomplete, command history, and reverse search for rapid interaction.
- Obsidian Sync & History: Programmatically check sync status, access file history versions, and perform diffs between file iterations.
- Developer Tools: Toggle DevTools, execute JavaScript via eval, capture window screenshots, and inspect DOM elements or CSS properties.
- Workspace Management: Save, load, and manage specific layout configurations and open tabs programmatically.
- Link Analysis: Maintain vault integrity by identifying orphan notes, dead ends, and unresolved links through terminal queries.
SKILL.md
Loading
Related Openclaw Skills
Notify Bot
A CLI utility designed to trigger Telegram bot sessions and send targeted notifications within group threads.
Xianyu Auto Fulfillment Framework
A highly extensible automation framework designed to detect Xianyu payments and trigger customizable virtual goods delivery workflows.
Xianyu Auto-Fulfillment Bot
A specialized automation skill for Goofish sellers to monitor chats and fulfill digital orders instantly using browser-based AI agents.
Prospector
An automated lead generation skill that identifies companies via Exa and enriches contact data using Apollo for precise ICP matching.
MoltRock
An autonomous on-chain hedge fund enabling AI agents to pool USDC, earn compounding vault shares, and govern strategies via meritocratic voting.
TaskFlow
TaskFlow provides a robust, markdown-centric project and task management framework for Openclaw Skills with SQLite synchronization and automated background daemons.
Featured*
