OmniFocus

OmniFocus is a professional task manager for organizing projects, actions, tags, and forecast views. Protocol Launcher allows you to generate OmniFocus URL scheme links for adding actions, pasting TaskPaper content, and opening key perspectives.

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 OmniFocus

On-Demand

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

const url = open()

Open OmniFocus

Add Action

Create a new action, optionally assigning project, tag/context, due date, flag, and x-callback-url parameters.

On-Demand

import { add } from 'protocol-launcher/omnifocus'

const url = add({
  name: 'Pick up milk',
  note: 'You gotta',
})

const url = add({
  name: 'Email team',
  context: 'Mac',
  due: 'jun 25 8am',
  estimate: '30m',
  flag: true,
  project: 'Launch',
  revealNewItem: true,
})

const url = add({
  name: 'My shiny new task',
  autosave: true,
  xSuccess: 'omnifocus:///',
})

Add Action Add Action with Metadata Add Action with Callback

Paste TaskPaper

Paste TaskPaper content into the Inbox, Projects, or another OmniFocus target.

On-Demand

import { paste } from 'protocol-launcher/omnifocus'

const url = paste({
  content: '- Pick up milk',
  target: 'inbox',
})

const url = paste({
  content: 'Launch:\n\t- Draft announcement',
  target: 'projects',
  index: 0,
})

Paste Task Paste Project

Open Built-In Perspectives

On-Demand

import { openInbox, openForecast, openToday } from 'protocol-launcher/omnifocus'

const inboxUrl = openInbox()
const forecastUrl = openForecast()
const todayUrl = openToday()

Open Inbox Open Projects Open Tags Open Flagged Open Forecast Open Past Open Today Open Soon

Open Custom Perspective

On-Demand

import { openPerspective } from 'protocol-launcher/omnifocus'

const url = openPerspective({
  name: 'Due Soon',
})

Open Custom Perspective

Open Task

On-Demand

import { openTask } from 'protocol-launcher/omnifocus'

const url = openTask({
  id: 'mbp0SlWkvqq',
})

Open Task

Official Documentation

• OmniFocus URL Schemes