Protocol Launcher

Editorial ​

Editorial is a powerful text editor and automation app for iOS and iPadOS. It features a Python-based scripting environment and workflow automation capabilities. Protocol Launcher allows you to generate deep links to open files, create new documents, run workflows, and open web pages in Editorial.

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 Editorial ​

On-Demand
ts
import { back } from 'protocol-launcher/editorial'

const url = back()
Open Editorial

Open Existing File ​

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

const url = open({
  filename: 'myfile.txt',
})
Open File in Editorial

Open File from Dropbox ​

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

const url = open({
  filename: 'myfile.txt',
  root: 'dropbox',
})
Open File from Dropbox

Open File with Selection ​

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

const url = open({
  filename: 'myfile.txt',
  selection: '0-10',
})
Open File with Text Selection

Open File with Workflow Command ​

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

const url = open({
  filename: 'myfile.txt',
  command: 'My Workflow',
})
Open File and Run Workflow

Create New File ​

On-Demand
ts
import { newFile } from 'protocol-launcher/editorial'

const url = newFile({
  filename: 'newfile.txt',
})
Create New File

Create New File in Dropbox ​

On-Demand
ts
import { newFile } from 'protocol-launcher/editorial'

const url = newFile({
  filename: 'newfile.txt',
  root: 'dropbox',
})
Create New File in Dropbox

Create New File with Selection ​

On-Demand
ts
import { newFile } from 'protocol-launcher/editorial'

const url = newFile({
  filename: 'newfile.txt',
  selection: '0-10',
})
Create New File with Selection

Create New File with Workflow Command ​

On-Demand
ts
import { newFile } from 'protocol-launcher/editorial'

const url = newFile({
  filename: 'newfile.txt',
  command: 'My Workflow',
})
Create New File and Run Workflow

Open Web Page (HTTP) ​

On-Demand
ts
import { openWeb } from 'protocol-launcher/editorial'

const url = openWeb({
  url: 'http://apple.com',
})
Open HTTP Page

Open Web Page (HTTPS) ​

On-Demand
ts
import { openWeb } from 'protocol-launcher/editorial'

const url = openWeb({
  url: 'https://google.com',
})
Open HTTPS Page

Run Workflow Command ​

On-Demand
ts
import { command } from 'protocol-launcher/editorial'

const url = command({
  command: 'My Workflow',
})
Run Workflow

Run Workflow with Input ​

On-Demand
ts
import { command } from 'protocol-launcher/editorial'

const url = command({
  command: 'My Workflow',
  input: 'some input',
})
Run Workflow with Input

Run Workflow with Success Callback ​

On-Demand
ts
import { command } from 'protocol-launcher/editorial'

const url = command({
  command: 'My Workflow',
  xSuccess: 'myapp://success',
})
Run Workflow with Callback