Obsidian SDK

Prerequisites

System requirements and setup needed before using the Obsidian SDK.

Prerequisites

Obsidian Version

  • v1.12.0 or higher

Catalyst License

  • An "Insider" tier license (one‑time $25) is currently required for early access to the CLI.

Running Application

  • The Obsidian desktop app must be open for the CLI to connect via IPC.

Activation

  • In Obsidian go to Settings → General → Command line interface → Enable.

Registration

  • Follow the prompt to "Register CLI path" to register the binary.

Path Setup

  • Ensure the obsidian binary is in your terminal's $PATH (or add the directory containing it to your shell's PATH).

On this page