obsidian-cli

Control a live Obsidian instance to debug and test plugins.

515|64|Updated Oct 23, 2024

Search Tags:#automation #debugging #cli #evaluation #obsidian #ui-testing #plugin-development

Ready to run

npx skills add https://github.com/allenhutchison/obsidian-gemini --skill obsidian-cli-allenhutchison

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: obsidian-cli
Source: https://github.com/allenhutchison/obsidian-gemini/tree/main/.agents/skills/obsidian-cli
Command: npx skills add https://github.com/allenhutchison/obsidian-gemini --skill obsidian-cli-allenhutchison

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Obsidian plugin developers often need to debug, inspect live states, and validate behavior without leaving their editor. The Obsidian CLI exposes direct control over a running Obsidian instance to streamline plugin development and troubleshooting.

Core Features & Use Cases

Debug runtime errors, verify plugin state after changes, and test migrations by driving a live vault.
Inspect console output, reload plugins, and evaluate code in the context of the running app.
Drive the UI (open modals, click controls, take screenshots) for automated testing or regression checks.

Quick Start

Reload the plugin after a rebuild and observe the console to confirm a clean load.

Frequently Asked Questions about obsidian-cli

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

FAQPage Schema

How do I debug an Obsidian plugin without leaving my code editor?▼

You can debug an Obsidian plugin by using a CLI to control a live Obsidian instance, allowing you to inspect console output and evaluate code directly from your editor during development workflows.

Can I automate UI testing for my Obsidian plugin?▼

Yes, you can automate UI testing by driving the live Obsidian app to open modals, click controls, and take screenshots for automated regression checks.

How do I reload an Obsidian plugin after rebuilding the code?▼

You can reload an Obsidian plugin instantly by sending a command via the CLI to the running instance, which allows you to verify a clean load and observe the console output immediately.

Does this CLI approach to Obsidian plugin testing require any specific dependencies?▼

The CLI approach for Obsidian plugin testing requires no external dependencies, allowing you to inspect live states and validate behavior immediately within your existing development environment.

What is the best way to inspect live state during Obsidian plugin development?▼

The best way to inspect live state during Obsidian plugin development is to use a CLI that evaluates code in the context of the running app, enabling you to troubleshoot and verify plugin behavior rapidly.

How do I test Obsidian plugin migrations against a live vault?▼

You can test Obsidian plugin migrations by driving a live vault with the CLI, which exposes direct control over the running instance to validate behavior and inspect state after changes.