obsidian

Alfred workflow for Obsidian note-taking app. Open vaults and files in Obsidian.

Author: Hause Lin
Last Updated: 24/12/20 00:38:22
Stars: 46

What is Obsidian?

Obsidian is really cool and free note-taking app that wants to be your second brain. To learn more about it, check out my Obsidian overview and how I use it to take notes (and why we take notes).

Alfred workflow for Obsidian

This simple Alfred workflow uses Obsidian‘s URI scheme and JXA actions/scripts (thanks to @hjklapp) to open notes in their vaults. This workflow has been tested in Obsidian 0.10.2.

Available Alfred features/keywords (contributors in parentheses)

  • Open a vault: ov,oo (@hjklapp)
  • Search for all markdown files on your computer: os, or, ot
  • Search for markdown files inside your vaults: oss, orr, ott
    • You can also customize your Hotkeys instead.
  • Create a new empty note and open in selected vault: on
  • Open a daily note in a vault: od (@technicalpickles, @luckman212)
    • You can also custommize your Hotkey to open your daily note.
  • Create or open tomorrow’s daily note: otmr
  • Fallback search when there are no results (@technicalpickles)
  • Get help by opening help vault and forum: o?

Installation

Download the latest release. Unzip and add the workflow to Alfred. Only tested in Alfred 4.

Features that require no set-up

Open a vault: ov

To open one of your many Obsidian vaults, type ov your_vault_name. If you vault name is my notes, you type ov my notes. You can change the keyword input subtext to remind yourself of the names of your vaults. Double-click ov Keyword to change the Subtext field.

All other features require a one-time set-up (v0.2.0 onward).

Set up

This version (≥ v0.2.0) of the workflow requires a one-time set-up.

  • Add your vaults, one at a time: oaddvault
    • Note that Obsidian’s help vault has been added by default.
  • To clear all vaults other than Obsidian’s help vault: oclearvaults
  • To clear a single vault: oclearvault

If you use Obsidian’s Daily notes plugin, you’ll also need to set it up.

  • Specify daily vault: odailyvault
  • Specify daily note format: odailyformat
    • Example: The date is 1st March 1990.
      • If your date format is 1990-3-1, enter yyyy-m-d
      • If your date format is 900301, enter yymmdd
      • If your date format is 1_3-90, enter d_m-yy
      • If your date format is 1 March 1990, enter d MMMM yyyy
      • If your date format is Mar 01, 90, enter MM dd, yy
  • Specify daily note directory/path: odailypath
  • Specify daily note template: odailytemplate
    • Required only if you have a template for daily notes.

Features available after set-up

Open a vault with autocomplete: oo

  • To autofill and autocomplete Obsidian vaults (suggested by @hjklapp): oo your_vault_name

Open daily note: od

  • The Daily notes Obsidian plugin must be enabled.
  • od opens today’s daily note. Alternatively, you can use a hotkey. If you’ve successfully followed all the set-up steps, od will also create today’s daily note if it doesn’t exist yet. If you see error messages, most likely you haven’t set things up properly. Follow the set-up instructions carefully and try again.

Create or open tomorrow’s daily note: otmr

Works the same way as od, but for tomorrow’s daily note. Great for planning your next day.

Search for markdown files: os, or, ot (or oss, orr, ott)

The keywords os, or, and ot will look for markdown files everywhere on your system (i.e., not just your vaults). If a file isn’t in any of your Obsidian vaults, the file will open in your default editor instead of Obsidian.

  • Search for all markdown files with the term xyz: os xyz
  • Search for recent files (last 3 days) with the term xyz: or xyz
  • Search for files modified today with the term xyz: ot xyz

To look for markdown files that are only inside your vaults, use oss, orr, and ott instead. These three keywords require you to first press enter before you can perform your search. You can also customize your hotekeys to perform these searches.

Create a new note: on

  • on will ask you to select a vault. Then you’ll enter the note name/title. The new note will open in the selected Obsidian vault.
  • If you don’t enter a note name, the default note name will look something like 20201121_151123, which is generated using Alfred’s dynamic placeholders: {date:yyyyMMdd_HHmmss}.

Alfred fallback search

Supports Alfred fallback searches (i.e., “Fallback searches are the list of search options you see when you search for a keyword that doesn’t match a result on your local Mac.”; see screenshot below). Thanks @technicalpickles for suggesting this feature.

When a fallback search is invoked, the workflow will ask which vault you want to search in. To set it up, follow these steps:

  • Go to Alfred’s Features pane, click Default Results pane, click Setup fallback results at the bottom, click the + icon, add a Workflow Trigger, add Search Obsidian for {query}, reorder the fallback searches however you prefer, and click Save.

Known bugs

If the Obsidian app isn’t already opened, this workflow will always open the last recently opened vault. This bug is a known issue with Electron apps on MacOS. See discussion on Obsidian’s Discord.

Contributors

Alphabetical order