obsidian

What This Skill Does

The Obsidian skill empowers you to interact with and automate tasks within your Obsidian vaults directly from the command line. Obsidian vaults are simply folders on your disk containing plain Markdown notes, configuration files, and attachments. This skill leverages obsidian-cli, a powerful tool designed to manage your Obsidian workspace programmatically. You can effortlessly search for notes by name or content, create new notes with pre-defined content, move or rename existing notes while ensuring all internal links are updated, and delete notes. It provides a robust way to integrate your note-taking workflow into broader automation scripts or to quickly manage your knowledge base without opening the Obsidian application.

Installation

To install the Obsidian skill, use the following command:

clawhub install openclaw/openclaw/skills/obsidian

This command fetches the skill from the openclaw/openclaw repository on Clawhub.

Use Cases

This skill is ideal for a variety of scenarios:

• Automated Note Creation: Generate daily journal entries, meeting minutes, or project notes with pre-filled templates.
• Knowledge Base Management: Quickly search your entire vault for specific information or facts.
• Refactoring Notes: Rename or move notes and automatically update all cross-references within your vault, preventing broken links.
• Content Archiving: Integrate with other tools to automatically archive or file information into your Obsidian vault.
• Command-Line Research: Perform quick content searches on your notes without needing to open the Obsidian GUI.
• Workflow Integration: Use Obsidian as a data store for other scripts and automate tasks like generating reports or summarizing information from your notes.

Example Prompts

1. "Find all notes related to 'project phoenix' and show me where they are."
2. "Create a new note in my 'Work/Meetings' folder called '2023-10-27 Standup' with the content 'Attendees: Alice, Bob. Action items: Review proposal.' and open it."
3. "Rename the note 'old/meeting-notes/2023-10-26' to 'archive/meetings/2023-10-26'."

Tips & Limitations

• Vault Detection: obsidian-cli intelligently detects your active vaults by reading ~/Library/Application Support/obsidian/obsidian.json. It's recommended to let the tool handle vault paths rather than hardcoding them.
• Default Vault: You can set a default vault for easier access using obsidian-cli set-default "<vault-folder-name>".
• Link Integrity: The move command is a significant advantage, as it automatically updates internal [[wikilinks]] and other Markdown links, which standard file system move operations do not handle.
• Direct Edits: For simple text edits, opening the .md file directly with a text editor and saving changes is often sufficient, as Obsidian automatically detects these modifications.
• URI Handler: Creating notes via obsidian-cli create relies on the Obsidian URI handler being correctly configured. Avoid creating notes within Obsidian's internal configuration folders (e.g., .obsidian/) using this method, as Obsidian might prevent it.
• Vault Structure: Be aware of your vault's structure, especially custom attachment folders. obsidian-cli primarily operates on notes (*.md) and the vault's top-level structure.
• Cross-Vault Operations: The current implementation focuses on operations within a single, specified or default vault. Cross-vault operations are not directly supported by this skill's interface.