Beorg

Beorg is a powerful task management app for iPhone and iPad that uses plain text files in Org mode syntax. Protocol Launcher allows you to generate deep links to open Beorg, capture tasks, search for items, and view your agenda and tasks.

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.

Open Beorg

On-Demand

import { open } from 'protocol-launcher/beorg'

const url = open()

Open Beorg

Capture

Add a new item to Beorg (capture).

On-Demand

import { capture } from 'protocol-launcher/beorg'

// Capture with title, notes, schedule and file
const url = capture({
  title: 'Shopping List',
  notes: 'Buy eggs',
  scheduled: '2017-10-03',
  file: 'shopping',
})

// Capture with deadline, template and edit option
const url = capture({
  title: 'New task',
  notes: 'Complete project',
  deadline: '2017-10-10',
  template: 'Daily Review',
  edit: true,
})

Capture Task Capture with Deadline

Search

Search for items in Beorg and return results as JSON.

On-Demand

import { search } from 'protocol-launcher/beorg'

// Simple search
const url = search({
  search: 't bookmark',
})

// Search with callback URL
const url = search({
  search: 't bookmark',
  xSuccess: 'shortcuts://x-callback-url/run-shortcut?name=ProcessResults',
})

Search in Beorg Search with Callback

Show Agenda

Show the agenda in Beorg.

On-Demand

import { showAgenda } from 'protocol-launcher/beorg'

const url = showAgenda()

Show Agenda

Show Tasks

Show the tasks tab in Beorg, optionally with a search filter.

On-Demand

import { showTasks } from 'protocol-launcher/beorg'

// Show all tasks
const url = showTasks({})

// Show tasks with search filter
const url = showTasks({
  search: 't bookmark',
})

Show All Tasks Show Tasks with Filter

View File

View a specific file in Beorg.

On-Demand

import { viewFile } from 'protocol-launcher/beorg'

const url = viewFile({
  file: 'shopping',
})

View File