Sketch

Sketch is a vector graphics editor for macOS primarily used for user interface and icon design. Protocol Launcher allows you to generate deep links to open files, add libraries, and run plugins in Sketch.

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 Sketch

On-Demand

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

const url = open()

Open Sketch

Open File

On-Demand

import { openFile } from 'protocol-launcher/sketch'

const url = openFile({
  path: '/Users/name/Documents/design.sketch',
})

Open File in Sketch

Open File with Layer Focus and Zoom

On-Demand

import { openFile } from 'protocol-launcher/sketch'

const url = openFile({
  path: '/Users/name/Documents/design.sketch',
  centerOnLayer: 'layer-123',
  zoom: 2,
})

Open File with Layer Focus in Sketch

Add Library

On-Demand

import { addLibrary } from 'protocol-launcher/sketch'

const url = addLibrary({
  url: 'https://developer.apple.com/design/downloads/sketch.rss',
})

Add Library to Sketch

Run Plugin

On-Demand

import { runPlugin } from 'protocol-launcher/sketch'

const url = runPlugin({
  pluginId: 'com.example.sketch.messenger',
  commandId: 'message.show',
})

Run Plugin in Sketch

Run Plugin with Query Parameters

On-Demand

import { runPlugin } from 'protocol-launcher/sketch'

const url = runPlugin({
  pluginId: 'com.example.sketch.messenger',
  commandId: 'message.show',
  query: { msg: 'Hello World' },
})

Run Plugin with Query in Sketch