Protocol Launcher

Postman ​

Postman is an API platform for building, testing, and collaborating on APIs. Protocol Launcher allows you to generate URLs for opening local Flow files in Postman.

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.

URL Methods ​

Postman's official Native Git / Flows documentation lists a postman://app/flows/open?filePath=... custom protocol link for opening local flows. The generated filePath value is a URL-encoded absolute path to the flow file. This module exposes only that documented form.

Open Local Flow ​

Generate the documented deep link that opens a local Postman Flow file. Pass the raw absolute path; Protocol Launcher encodes it in the generated URL.

On-Demand
ts
import { openLocalFlow } from 'protocol-launcher/postman'

const url = openLocalFlow({
  filePath: '/Users/username/GitHub/postman/flows/New flow.flow',
})
Open Local Flow

Generated URLs ​

ts
openLocalFlow({ filePath: '/Users/username/GitHub/postman/flows/New flow.flow' })
// => 'postman://app/flows/open?filePath=%2FUsers%2Fusername%2FGitHub%2Fpostman%2Fflows%2FNew%20flow.flow'

Official Documentation ​