https://github.com/bizzabo/syncman
https://github.com/bizzabo/syncman
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bizzabo/syncman
- Owner: bizzabo
- Created: 2022-04-25T07:05:49.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-19T14:02:22.000Z (almost 3 years ago)
- Last Synced: 2025-05-18T07:40:46.177Z (about 1 year ago)
- Language: TypeScript
- Size: 125 KB
- Stars: 2
- Watchers: 34
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Syncman
A CLI tool that syncs an OAS file to Postman and generates a Postman collection from it
## Installation
In your terminal run:
```
npm i -g syncman
```
## Usage
Make sure you have the following env variables set up:
- `POSTMAN_API_KEY` - you can get it from here: [https://your-postman-subdomain.postman.co/settings/me/api-keys](https://your-postman-subdomain.postman.co/settings/me/api-keys)
- `POSTMAN_WORKSPACE_ID` - your Postman Workspace id
You can do it by exporting them in your terminal:
```
export POSTMAN_API_KEY=
export POSTMAN_WORKSPACE_ID=
```
Then run:
```
syncman --location --apiname "" --versionname ""
```
`versionname` is optional, and if not provided will be equal to `Latest`
## Local Development
To test it locally, run:
```
npm run sync -- --apiname "My Lovely Api" --location oas-test.yaml --versionname V1
```