Bunch

Bunch is a macOS workspace automation app. Protocol Launcher allows you to generate deep links for Bunch.

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.

URL Methods

All helpers below support Bunch's documented x-callback-url path format and official x-source, x-success, x-delay, and x-bunch-beta URL values when those parameters apply.

Open Bunch

On-Demand

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

const url = open({
  bunch: 'Comms',
})

const shortcutUrl = open({
  bunch: 'Comms',
  syntax: 'shortcut',
})

const pathUrl = open({
  bunch: 'WorkBunch',
  syntax: 'path',
})

Open Bunch Full URL Open Bunch Shortcut URL Open Bunch Path URL

Open Bunch Beta

On-Demand

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

const url = open({
  bunch: 'Comms',
  scheme: 'x-bunch-beta',
})

Open in Bunch Beta

Open With Frontmatter Values

On-Demand

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

const url = open({
  bunch: 'Default',
  variables: {
    launch: 'TextEdit',
  },
})

Open With Variables

Open With Callback Parameters

On-Demand

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

const callbackUrl = open({
  bunch: 'Comms',
  xCallback: true,
  'x-source': 'com.googlecode.iterm2',
})

const successUrl = open({
  bunch: 'Comms',
  'x-success': 'com.brettterpstra.marked2',
  'x-delay': 15,
})

Open With x-callback-url Open Then Launch Marked 2

Close Bunch

On-Demand

import { close } from 'protocol-launcher/bunch'

const url = close({
  bunch: 'Comms',
})

const pathUrl = close({
  bunch: 'Comms',
  syntax: 'path',
})

Close Bunch Full URL Close Bunch Path URL

Toggle Bunch

On-Demand

import { toggle } from 'protocol-launcher/bunch'

const url = toggle({
  bunch: 'Comms',
})

const pathUrl = toggle({
  bunch: 'Comms',
  syntax: 'path',
})

Toggle Bunch Full URL Toggle Bunch Path URL

Toggle Tagged Bunches

On-Demand

import { toggle } from 'protocol-launcher/bunch'

const url = toggle({
  tag: 'Tag1+Tag2',
})

Toggle Tagged Bunches

Edit Bunch

On-Demand

import { edit } from 'protocol-launcher/bunch'

const url = edit({
  bunch: 'Example',
})

const pathUrl = edit({
  bunch: 'Example',
  syntax: 'path',
})

Edit Bunch Full URL Edit Bunch Path URL

Run Raw Bunch Text Or File

On-Demand

import { raw } from 'protocol-launcher/bunch'

const fileUrl = raw({
  file: '~/MiscBunch.bunch',
})

const textUrl = raw({
  txt: '(dnd on)',
})

Run Raw File Run Raw Text

Refresh Bunch Files

On-Demand

import { refresh } from 'protocol-launcher/bunch'

const url = refresh()

Refresh Bunch Files

Reveal Bunch Folder

On-Demand

import { reveal } from 'protocol-launcher/bunch'

const url = reveal()

Reveal Bunch Folder

Set Preferences

On-Demand

import { setPref } from 'protocol-launcher/bunch'

const toggleUrl = setPref({
  toggleBunches: 1,
})

const folderUrl = setPref({
  configDir: '~/Dropbox/Sync/Bunches',
})

Enable Toggle Bunches Set Bunch Folder

Run Snippet

On-Demand

import { snippet } from 'protocol-launcher/bunch'

const url = snippet({
  file: 'useful.snippets',
  fragment: 'Music',
  variables: {
    playlist: 'spotify:playlist:3cSpIL4Q0H3uqdBMbT6c9x',
  },
})

const pathUrl = snippet({
  file: 'useful.snippets',
  fragment: 'Speak',
  syntax: 'path',
  variables: {
    var1: 'foo',
    var2: 'bar baz',
  },
})

Run Snippet Full URL Run Snippet Path URL

Open Preferences

On-Demand

import { prefs } from 'protocol-launcher/bunch'

const url = prefs()

Open Bunch Preferences

Official Documentation

• The Bunch URL Handler