GitHub Desktop

GitHub Desktop is a desktop application for version control and collaboration with GitHub. Protocol Launcher allows you to generate deep links to open and configure resources in GitHub Desktop.

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 File

On-Demand

import { openFile } from 'protocol-launcher/github-desktop'

const url = openFile({
  owner: 'zhensherlock',
  repo: 'protocol-launcher',
  branch: 'main',
  path: 'packages/shared/src/index.ts',
})

Open in GitHub Desktop

Open Repository

On-Demand

import { openRepo } from 'protocol-launcher/github-desktop'

const url = openRepo({
  owner: 'zhensherlock',
  repo: 'protocol-launcher',
  branch: 'main',
})

Open in GitHub Desktop