Protocol Launcher

Diarly ​

Diarly is a journaling app for writing and organizing daily entries. Protocol Launcher allows you to generate links for opening entries or notes, appending text, creating notes, and searching entries in Diarly.

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.

Diarly documents diarly://x-callback-url/[action]?[parameters] for open, append, and create, plus diarly://search?text=... for search. Daily entry identifiers use day in dd-mm-yyyy format and optional journal; note identifiers use id.

Open ​

Open a note by its unique id.

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

const url = open({
  id: 'REPLACE_WITH_NOTE_ID',
})

Open a daily entry with day and optional journal.

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

const url = open({
  day: '01-01-2019',
  journal: '2bc759b2-9dd8-4186-ba64-12890f5642c9',
})
Open in Diarly

Append / Add ​

Append text to a note or daily entry identified by id or by day and optional journal.

On-Demand
ts
import { append } from 'protocol-launcher/diarly'

const url = append({
  day: '16-12-2020',
  text: 'Hello World',
})
On-Demand
ts
import { append } from 'protocol-launcher/diarly'

const url = append({
  id: 'REPLACE_WITH_NOTE_ID',
  text: 'Hello World',
})

Create Note ​

Create a new note with text and optional journal.

On-Demand
ts
import { create } from 'protocol-launcher/diarly'

const url = create({
  text: 'Hello World',
})
On-Demand
ts
import { create } from 'protocol-launcher/diarly'

const url = create({
  journal: 'Personal',
  text: 'Hello World',
})

Search Diarly entries with text.

On-Demand
ts
import { search } from 'protocol-launcher/diarly'

const url = search({
  text: '@onThisDay',
})
Search in Diarly

Official Documentation ​