Skip to content

Latest commit

 

History

History
156 lines (90 loc) · 5.17 KB

README.md

File metadata and controls

156 lines (90 loc) · 5.17 KB
Raw

ulauncher-notes-nv

A NotationalVelocity-inspired Ulauncher extension for storing and retrieving notes as individual text files.

Features

  • Keyboard-centric search-first user experience: every action, including new note creation, begins with a search
  • Intuitive fuzzy search of note titles and contents in Ulauncher
  • Plain text: notes are stored as individual plain text files in a directory - use your favorite tools to keep them synchronized across devices
  • Bring Your Own Editor: use your favorite editor to view and edit notes
  • Clipboard: create notes from the contents of the clipboard, or copy the note contents into the clipboard directly from Ulauncher - useful for managing text snippets

Usage

Open Ulauncher and type in "nv " to start the extension. If everything is configured correctly, you'll see a partial list of your notes files, most recently modified on top:

All notes, no query

Start typing a search query to get instant search results. Select an note and press Enter to open it in the text editor that you configured in Preferences:

Query 1

The more concrete the search, the smaller the list of search results:

Query 2

Use the search query as a title of a new note. Decide whether you want an empty note or one with the contents of your clipboard and press Enter:

Create note

Power user feature: commands

ulauncher-notes-nv allows you to perform simple operations on your notes using a "pipe to" syntax inspired by Unix command line:

cp: Copy note to clipboard

Specifying |cp before or after the search pattern causes the selected note to be copied to the clipboard instead of being opened in a text editor:

Copy note

Copy note

Installation

Open Ulauncher preferences window -> Extensions -> "Add extension" and paste the following url:

https://github.com/pbkhrv/ulauncher-notes-nv

Configuration

  • Notes directory path: path to where your notes files are stored.
  • Command to open note: command to be executed to open the selected note file. Use the {fn} field to insert the full path to the note file. (If left empty, default application associated with that file type will be executed via xdg-open, e.g. default for .txt in Ubuntu is gedit)

Some examples of the "open note" terminal command:

gvim {fn}

gedit --new-document {fn}

gedit

Open note in Obsidian:

xdg-open "obsidian://open?path={fn}"

(If you don't specify {fn}, the note file path will be automatically passed to the editor as the last argument.)

Why?

NotationalVelocity is a Mac OS application with a cult following. In its own words:

NOTATIONAL VELOCITY is an application that stores and retrieves notes.

It is an attempt to loosen the mental blockages to recording information and to scrape away the tartar of convention that handicaps its retrieval. The solution is by nature nonconformist.

The "nonconformist" part is the one where NV ditched the traditional file-oriented actions of "create", "open" etc to reduce the number of steps required to store or access a piece of textual content:

Searching for notes is not a separate action; rather, it is the primary interface.

Searching encompasses all notes' content and occurs instantly with each key pressed.

Notational Velocity's window was designed for keyboard input above all else, and thus has no buttons.

Ulauncher happens to share the search-centric design goals. The only thing it doesn't provide is a text editor, and the hope is that using an external editor won't detract from the overall user experience too much.

Development

I use the following tools while working on this extension:

  • Black code formatter
  • pytest
  • pylint with the flake8 plugin
  • mypy static type checker

You can install them in one shot (except for Black - that's up to you) by running:

pip install -r scripts/requirements.txt

Check PEP8 compliance, perform static type analysis and run unit tests:

make test

Backup the "production" version of the extension and symlink the development version into Ulauncher's extension directory:

make symlink

Quit Ulauncher. Then run it in debug mode:

make run_ul

Run extension in the terminal, connect it to Ulauncher in debug mode:

make run

(if that doesn't work, check the connection string URL printed out by Ulauncher and modify the Makefile accordingly.)

Unlink the development version of the extension from Ulauncher and replace it with whatever was there before:

make unlink

Contributions

Issues and pull requests are welcome!

Inspiration and thanks

I loved NotationalVelocity and its modern fork NVAlt on Mac OS, and I've been (largely unsuccessfully) searching for something as good on Linux for a while. This extension is clearly not "as good" but it's "good enough".