A Stream Deck plugin that runs commands in Obsidian.

Demo

View the plugin in action by clicking on the video below:

Installation

1. Install the Local REST API plugin for Obsidian.
2. Install this plugin from the Elgato Marketplace or download directly from releases.

Configuration

In order to interact with Obsidian through the Local REST API, the plugin needs the (1) API Key and the (2) URL.

These configuration items can be found in the Local REST API plugin settings.

The plugin will use HTTPS by default and provides a self-signed certificate. Alternatively, you can enable an HTTP server by toggling the Enable Non-Encrypted (HTTP) server option.

Depending on your desired configuration (using HTTPS or HTTP, custom ports), the full URL should look like:

${scheme}://localhost:${port}

where scheme is either http or https and port is the corresponding port relative to the selected scheme.

Run Command action

The Run Command action has the following required config items:

• API Key
• URL
• Command ID

The configuration section details how to retrieve the API Key and URL config items.

The Command ID can be obtained by calling the /commands endpoint of the Local REST API, through the command line or the Local REST API playground.

Sample call to the commands endpoint using curl, if you're running MacOS:

curl -X 'GET' \
  'http://127.0.0.1:27123/commands/' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer api_key_goes_here'

# Sample response
{
  "commands": [
    {
      "id": "app:open-help",
      "name": "Open Help"
    },
    ...
  ]
}

If you're running Windows, run the following command:

curl -X "GET" ^
  "http://127.0.0.1:27123/commands/" ^
  -H "accept: application/json" ^
  -H "Authorization: Bearer api_key_goes_here"

Standard commands

For ease of use, the following section lists all the available commands for a vanilla Obsidian installation. Commands from other (community) plugins can be obtained by calling the commands endpoint.

Open File action

The Open File action has the following required config items:

• API Key
• URL
• File Path

The configuration section details how to retrieve the API Key and URL config items.

A couple of things to note regarding File Path, the first is that it is relative to the current vault root and the other is that the forward slash character (/) must be used as the file separator.

Consider the following example where notes is the name of the current vault.

notes/
├── 1.md
└── dir
    └── 2.md

The file path for the first file will be 1.md while the path for the other file will be dir/2.md.