Skip to content

Warp

Warp is a modern terminal for developers. Protocol Launcher allows you to generate deep links to open new Warp windows, tabs, Launch Configurations, and Tab Configs.

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 New Window

On-Demand
ts
import { newWindow } from 'protocol-launcher/warp'

const url = newWindow({
  path: 'path_to_folder',
})

Open New Tab

On-Demand
ts
import { newTab } from 'protocol-launcher/warp'

const url = newTab({
  path: 'path_to_folder',
})

Open Launch Configuration

On-Demand
ts
import { launchConfiguration } from 'protocol-launcher/warp'

const url = launchConfiguration({
  path: 'launch_configuration_path',
})

Open Tab Config

On-Demand
ts
import { tabConfig } from 'protocol-launcher/warp'

const url = tabConfig({
  name: 'my_tab',
  newWindow: true,
})

Warp Preview

Warp's official URI scheme documentation says Warp Preview uses the warppreview:// scheme. Pass scheme: 'warppreview' to target Warp Preview with the same helpers.

On-Demand
ts
import { newTab } from 'protocol-launcher/warp'

const url = newTab({
  path: 'path_to_folder',
  scheme: 'warppreview',
})

Official Warp URI Scheme documentation