Quick Start

Install The Plugin

Community Plugin

Since this plugin isn't officially released in the Community Plugins store yet, the easiest way to install it is with Obsidian BRAT, which lets you install plugins directly from GitHub.

After BRAT is enabled:

• Open Settings
• Go to BRAT
• Click Add Beta Plugin
  • You'll be asked for the plugin's GitHub repository URL. (https://github.com/mcmanussliam/obsidian-actions)
• Install it

Manual Install

Copy the plugin into vault/.obsidian/plugins/actions:

Manual Install

Copy the plugin into <vault>/.obsidian/plugins/actions:

Then enable Obsidian Actions in Community Plugins.

Create Your First Action

1. Open Settings -> Actions.
2. Click Create.
3. Fill in the action:

4. Save the action.
5. Restart Obsidian.

Create A Test Action

Start with a manual JavaScript action:

new Notice("Action ran");

Use these fields:

• hook: manual
• type: js
• enabled: true

After restarting Obsidian, open the command palette and run the action by name.

You can also use the play button in the settings screen to test directly.

Add Runtime Variables

Action code is rendered before execution, so you can reference values from the current vault and editor state.

echo "Current file: {{{relative_path}}}"

Use triple braces when you want the raw value inserted directly.

Move To Automatic Hooks

Once a manual action behaves correctly, move it to startup, interval, or a file hook.

That keeps debugging simple and reduces the risk of noisy or repeated runs while you are still developing the action.