Skip to content

Getting Started

Installation

Install protocol-launcher using your preferred package manager:

sh
$ npm install protocol-launcher
sh
$ pnpm add protocol-launcher
sh
$ yarn add protocol-launcher
bash
$ bun add protocol-launcher

Usage

To minimize bundle size, import specific modules directly:

typescript
// Only imports Cherry Studio related code
import { installMCP } from 'protocol-launcher/cherry-studio'
typescript
// Only imports Cursor related code
import { installMCP } from 'protocol-launcher/cursor'
typescript
// Only imports GitHub Desktop related code
import { openRepo } from 'protocol-launcher/github-desktop'
typescript
// Only imports GoLand related code
import { openRepo } from 'protocol-launcher/goland'
typescript
// Only imports IntelliJ IDEA related code
import { openRepo } from 'protocol-launcher/idea'
typescript
// Only imports PhpStorm related code
import { openRepo } from 'protocol-launcher/phpstorm'
typescript
// Only imports PyCharm related code
import { openRepo } from 'protocol-launcher/pycharm'
typescript
// Only imports RustRover related code
import { openRepo } from 'protocol-launcher/rustrover'
typescript
// Only imports Telegram related code
import { open } from 'protocol-launcher/telegram'
typescript
// Only imports Thunder related code
import { downloadUrl } from 'protocol-launcher/thunder'
typescript
// Only imports VS Code related code
import { openFile } from 'protocol-launcher/vscode'
typescript
// Only imports WebStorm related code
import { openRepo } from 'protocol-launcher/webstorm'
typescript
// Only imports Xcode related code
import { cloneProject } from 'protocol-launcher/xcode'

Full Import

You can also import everything from the root package, but this will include all application modules and does not support tree-shaking:

typescript
import { cherryStudio, cursor, githubDesktop } from 'protocol-launcher'

For detailed usage instructions for each application, please refer to their respective guides: