How do I install the Obsidian CLI skill?

Run npx skillmds@latest add rudironsoni/obsidian-cli-2 in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Obsidian CLI safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Obsidian CLI?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Obsidian CLI free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Obsidian CLI?

rudironsoni (@rudironsoni) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Obsidian CLI by rudironsoni — Agent Skill

Name: Obsidian CLI
Author: rudironsoni

Obsidian CLI

Use the Obsidian CLI to inspect a running advanced-code-block Obsidian plugin session during development. Covers plugin reloads, console/errors, runtime evaluation, settings tab checks, reading-mode and live-preview syntax highlighting, screenshots, and mobile emulation with app.emulateMobile(true). Use WebdriverIO for automated runtime acceptance.

rudironsoni ff225ef 3.6 KB Updated Sep 17, 2026

File contents

Obsidian CLI For Advanced Code Editor

Use this skill to inspect a running Obsidian instance while developing advanced-code-block. Prefix shell commands with rtk in this repo.

Essentials

rtk obsidian plugin:reload id=advanced-code-block
rtk obsidian dev:errors
rtk obsidian dev:console level=error
rtk obsidian commands filter=advanced-code-block
rtk obsidian command id=advanced-code-block:reload-highlighter

plugin:reload can return success even when plugin load threw. Always follow with dev:errors or dev:console level=error.

Runtime State

rtk obsidian eval code="app.plugins.plugins['advanced-code-block'] !== undefined"
rtk obsidian eval code="JSON.stringify(app.plugins.plugins['advanced-code-block'].settings, null, 2)"
rtk obsidian eval code="app.plugins.plugins['advanced-code-block'].highlighter !== undefined"
rtk obsidian eval code="app.vault.getName()"

Open settings:

rtk obsidian eval code="app.setting.open(); app.setting.openTabById('advanced-code-block')"
rtk obsidian dev:screenshot path=planning/test-reports/settings.png

Syntax Highlighting Checks

Reading mode should render Expressive Code blocks:

rtk obsidian dev:dom selector="div.expressive-code" text
rtk obsidian dev:dom selector="div.expressive-code pre code" text

Live Preview should show token styling in the editor:

rtk obsidian dev:dom selector=".cm-content [style*='color'], .cm-content [class*='shiki']" text

Inline highlighting should render only {lang} code inline spans:

rtk obsidian dev:dom selector=".shiki-inline" text

When screenshots are needed:

rtk obsidian dev:screenshot path=planning/test-reports/live-preview.png

Mobile Emulation

Use the official Obsidian runtime API when possible. This executes mobile-guarded paths by setting app.isMobile:

rtk obsidian eval code="app.emulateMobile(true)"
rtk obsidian plugin:reload id=advanced-code-block
rtk obsidian dev:screenshot path=planning/test-reports/mobile.png
rtk obsidian eval code="app.emulateMobile(false)"

If using CLI support, pass an explicit state and never rely on toggle behavior:

rtk obsidian dev:mobile on
rtk obsidian plugin:reload id=advanced-code-block
rtk obsidian dev:mobile off

Automated Runtime Checks

Use WebdriverIO package scripts for automated interaction checks. Do not add CDP probes for runtime acceptance.

rtk bun run test:bdd
rtk bun run test:bdd:scroll

Footguns

Confirm app.vault.getName() before destructive actions.
dev:mobile or app.emulateMobile(true) persists until turned off.
CSS variable token colors are expected when the plugin uses the built-in Obsidian theme.
A blank screenshot usually means UI did not settle. Inspect DOM before retesting.

Resource Rules

One Obsidian instance only. Never spawn a second instance. WDIO tests must run with maxInstances: 1 and reuse the same Obsidian session across setup, debugging, and verification.
If an instance is already running, reuse it: reload plugin, re-copy plugin files into the existing vault, and reload the test note.
If you accidentally launch twice, kill the duplicate. Never leave orphan processes.
plugin:reload is cheap and idempotent. Prefer it over relaunching Obsidian.

---name: obsidian-cli-2description: Use the Obsidian CLI to inspect a running advanced-code-block Obsidian plugin session during development. Covers plugin reloads, console/errors, runtime evaluation, settings tab checks, reading-mode and live-preview syntax highlighting, screenshots, and mobile emulation with app.emulateMobile(true). Use WebdriverIO for automated runtime acceptance.---# Obsidian CLI For Advanced Code EditorUse this skill to inspect a running Obsidian instance while developing `advanced-code-block`.Prefix shell commands with `rtk` in this repo.## Essentials```bashrtk obsidian plugin:reload id=advanced-code-blockrtk obsidian dev:errorsrtk obsidian dev:console level=errorrtk obsidian commands filter=advanced-code-blockrtk obsidian command id=advanced-code-block:reload-highlighter````plugin:reload` can return success even when plugin load threw. Always follow with `dev:errors` or `dev:console level=error`.## Runtime State```bashrtk obsidian eval code="app.plugins.plugins['advanced-code-block'] !== undefined"rtk obsidian eval code="JSON.stringify(app.plugins.plugins['advanced-code-block'].settings, null, 2)"rtk obsidian eval code="app.plugins.plugins['advanced-code-block'].highlighter !== undefined"rtk obsidian eval code="app.vault.getName()"```Open settings:```bashrtk obsidian eval code="app.setting.open(); app.setting.openTabById('advanced-code-block')"rtk obsidian dev:screenshot path=planning/test-reports/settings.png```## Syntax Highlighting ChecksReading mode should render Expressive Code blocks:```bashrtk obsidian dev:dom selector="div.expressive-code" textrtk obsidian dev:dom selector="div.expressive-code pre code" text```Live Preview should show token styling in the editor:```bashrtk obsidian dev:dom selector=".cm-content [style*='color'], .cm-content [class*='shiki']" text```Inline highlighting should render only `{lang} code` inline spans:```bashrtk obsidian dev:dom selector=".shiki-inline" text```When screenshots are needed:```bashrtk obsidian dev:screenshot path=planning/test-reports/live-preview.png```## Mobile EmulationUse the official Obsidian runtime API when possible. This executes mobile-guarded paths by setting `app.isMobile`:```bashrtk obsidian eval code="app.emulateMobile(true)"rtk obsidian plugin:reload id=advanced-code-blockrtk obsidian dev:screenshot path=planning/test-reports/mobile.pngrtk obsidian eval code="app.emulateMobile(false)"```If using CLI support, pass an explicit state and never rely on toggle behavior:```bashrtk obsidian dev:mobile onrtk obsidian plugin:reload id=advanced-code-blockrtk obsidian dev:mobile off```## Automated Runtime ChecksUse WebdriverIO package scripts for automated interaction checks. Do not add CDP probes for runtime acceptance.```bashrtk bun run test:bddrtk bun run test:bdd:scroll```## Footguns- Confirm `app.vault.getName()` before destructive actions.- `dev:mobile` or `app.emulateMobile(true)` persists until turned off.- CSS variable token colors are expected when the plugin uses the built-in Obsidian theme.- A blank screenshot usually means UI did not settle. Inspect DOM before retesting.## Resource Rules- **One Obsidian instance only.** Never spawn a second instance. WDIO tests must run with `maxInstances: 1` and reuse the same Obsidian session across setup, debugging, and verification.- If an instance is already running, reuse it: reload plugin, re-copy plugin files into the existing vault, and reload the test note.- If you accidentally launch twice, kill the duplicate. Never leave orphan processes.- `plugin:reload` is cheap and idempotent. Prefer it over relaunching Obsidian.

Frequently asked questions