Skip to content

FSNotes ​

FSNotes is a modern notes manager for macOS and iOS. It's simple, blazing fast, and respects open formats like GitHub Flavored Markdown. Protocol Launcher allows you to generate deep links to search, open, or create notes in FSNotes.

Usage ​

There are two ways to use this library:

  • On-Demand import from subpaths enables tree-shaking and keeps bundles small.
  • Full Import from the root package is convenient but includes all app modules.

Pick On-Demand for production builds; Full Import is fine for quick scripts or demos.

Select Installation Method

On-Demand
Recommended. Optimized for production.
Full Import
Convenient. Good for quick scripts.

The current macOS URL handler supports new, open and find. openNote() accepts txt to append content (or create the note if absent); tag takes precedence over title. findNotes() accepts an optional id to open a title/name, falling back to search. Query values and search path components are encoded.

Open FSNotes ​

On-Demand
ts
import { open } from 'protocol-launcher/fsnotes'

const url = open()

Find Note ​

On-Demand
ts
import { findNotes } from 'protocol-launcher/fsnotes'

const url = findNotes({
  keyword: 'hello',
})

Open Note ​

On-Demand
ts
import { openNote } from 'protocol-launcher/fsnotes'

const url = openNote({
  title: 'hello',
  tag: '2026',
})

Create Note ​

On-Demand
ts
import { createNote } from 'protocol-launcher/fsnotes'

const url = createNote({
  title: 'hello',
  content: 'hello world',
  tags: '2026',
})

Create with the Native Scheme ​

Use the native fsnotes://new/ route. Plain text (txt) takes precedence over html, folder selects the destination, and open: true opens a new window. The existing createNote() helper retains the compatible nv://make/ route and supports txt/open.

On-Demand
ts
import { newNote } from 'protocol-launcher/fsnotes'

const url = newNote({
  'title': 'Meeting',
  'txt': '# Agenda',
  'folder': 'Work',
  'open': true
})

Official Documentation ​