obsidian-cli

Manage Obsidian notes and develop plugins via the Obsidian CLI.

1|Updated Feb 13, 2021
One-click install
npx skills add https://github.com/driftingly/dotfiles --skill obsidian-cli-driftingly
Or copy as Structured Prompt for Agentโ–ผ
Please help me install this Agent Skill.
Skill: obsidian-cli
Source: https://github.com/driftingly/dotfiles/tree/main/config/claude/skills/obsidian-cli
Command: npx skills add https://github.com/driftingly/dotfiles --skill obsidian-cli-driftingly

SYSTEM DOCUMENTATION & REQUIREMENTS

๐Ÿ’ก This Skill requires obsidian-cli, and includes scripts (resource) components.

What problem does it solve?

This Skill addresses the need for command-line interaction with Obsidian CLI, allowing users to manage notes, perform searches, and develop plugins and themes with ease.

Core Features & Use Cases

  • Command-Line Utility: Execute a range of commands for managing notes, searching vault content, and running JavaScript for plugin and theme development.
  • Plugin & Theme Development: Provides commands to reload plugins, run JavaScript, capture errors, take screenshots, and inspect the DOM.
  • Use Case: For instance, when a user wants to quickly create a new note with specific properties or search for a specific term within a vault.

Quick Start

To search for a term in your Obsidian vault, simply type 'search "your term"'.

Frequently Asked Questions about obsidian-cli

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I manage Obsidian notes from the command line?โ–ผ

The Obsidian CLI enables command-line management of notes, allowing you to read, create, and search vault content directly. It provides a range of commands for note management without needing the graphical interface.

Can I develop Obsidian plugins and themes using a CLI tool?โ–ผ

Yes, you can develop Obsidian plugins and themes using the CLI, which provides commands for reloading plugins, running JavaScript, and inspecting the DOM. It streamlines the development process by capturing errors and taking screenshots within the environment.

What is the best way to search for a specific term inside an Obsidian vault?โ–ผ

The best way to search for a specific term inside an Obsidian vault is using the CLI's search command, such as typing 'search "your term"'. This command-line utility directly queries your vault content and returns matching notes efficiently.

Does the Obsidian CLI support JavaScript execution and DOM inspection?โ–ผ

Yes, the Obsidian CLI supports JavaScript execution and DOM inspection for plugin and theme development. It provides specific commands to run JavaScript code, capture errors, inspect the DOM, and take screenshots within the Obsidian environment.

Do I need to install the obsidian-cli package to manage my notes via command line?โ–ผ

Yes, you need to install the obsidian-cli package as a dependency to manage your notes via command line. This prerequisite environment setup enables the Skill to execute commands for reading, searching, and creating vault content.

Why use a command line interface for Obsidian note management instead of the app?โ–ผ

Using a command line interface for Obsidian note management allows for faster, scriptable interactions with your vault. It enables quick note creation, automated searching, and streamlined plugin development without manually navigating the application's graphical interface.