organize-postman-export
v0.1.2
Published
A CLI tool to export all Postman workspaces, collections, and environments in an organized structure.
Downloads
23
Maintainers
Readme
Postman Exporter
A powerful CLI tool to export all your Postman workspaces, collections, and environments in an organized directory structure.
Features
- 🚀 Export all Postman workspaces at once
- 📚 Export collections and environments for each workspace
- 🏗️ Organize exports in a clean directory structure
- 🎨 Beautiful colored console output
- ⚡ Built with TypeScript for reliability
- 🔧 Simple CLI interface
Usage
Prerequisites
You need a Postman API key to use this tool:
- Go to Postman API Keys
- Generate a new API key
- Copy the API key for use with this tool
Basic Usage
npx organize-postman-export export --api-key YOUR_POSTMAN_API_KEYAdvanced Usage
# Export to a custom directory
npx organize-postman-export export --api-key YOUR_API_KEY --output my-postman-exports
# Show help
npx organize-postman-export --help
# Show version
npx organize-postman-export --versionOutput Structure
The tool organizes your exports in the following structure:
postman_workspaces/
├── Personal_Workspace/
│ ├── collections/
│ │ ├── My_API_Collection.postman_collection.json
│ │ └── Another_Collection.postman_collection.json
│ └── environments/
│ ├── global.postman_globals.json
│ ├── Development.postman_environment.json
│ └── Production.postman_environment.json
├── Team_Workspace/
│ ├── collections/
│ │ ├── Team_API.postman_collection.json
│ │ └── Integration_Tests.postman_collection.json
│ └── environments/
│ └── Staging.postman_environment.json
└── Project_Workspace/
├── collections/
│ └── Project_API.postman_collection.json
└── environments/
└── Local.postman_environment.jsonCLI Options
| Option | Short | Description | Required | Default |
| ----------- | ----- | ----------------------------------- | -------- | -------------------- |
| --api-key | -k | Your Postman API Key | Yes | - |
| --output | -o | Output directory for exported files | No | postman_workspaces |
| --version | -v | Show version number | No | - |
| --help | -h | Show help information | No | - |
Environment Variables
You can also set your API key as an environment variable:
export POSTMAN_API_KEY="your-api-key-here"
npx organize-postman-export exportRequirements
- Node.js 20.0.0 or higher
- Valid Postman API key
- Internet connection
