Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bcariaga/buildman
A tool for making files from a Postman Collection and vice versa
https://github.com/bcariaga/buildman
nodejs postman postman-collection
Last synced: 28 days ago
JSON representation
A tool for making files from a Postman Collection and vice versa
- Host: GitHub
- URL: https://github.com/bcariaga/buildman
- Owner: bcariaga
- License: mit
- Created: 2018-09-11T23:00:55.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T04:32:23.000Z (about 2 years ago)
- Last Synced: 2024-11-08T10:35:27.013Z (about 2 months ago)
- Topics: nodejs, postman, postman-collection
- Language: JavaScript
- Homepage: https://bcariaga.github.io/buildman/
- Size: 402 KB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# buildman  [](https://travis-ci.com/bcariaga/buildman) [](https://codecov.io/gh/bcariaga/buildman) [](https://github.com/bcariaga/buildman/blob/master/LICENSE)
A tool for making files from a Postman Collection and vice versa
---
## Docs:
[https://bcariaga.github.io/buildman/](https://bcariaga.github.io/buildman/)
## Getting Started
buildman was created on Node.js. To use buildman, you need have [Node.js](https://nodejs.org/es/) installed.
You can install buildman by npm:
`npm install @bcariaga/buildman --global`
_Note: Is recomendly install buildman globally (--global or -g) to can run it anywhere._
---
## Usage
### Import
To **import** a postman´s collection **(create a files and folder)** you need run:
`buildman import "path/to/collection.json" "path/to/target/folder"`
**NOTE:** If the request name contains special chars **(_\/:*?"<>|_)** they be **replace to "-"**.
Example: postman's folder with name "api/v1" be replace to "api-v1"
### Export
To **export** files and folders to postman´s collection :
`buildman export "path/to/collection/folder" "path/to/save/collection"`
_Note: the files and folders need a especific format, please see the [docs](https://bcariaga.github.io/buildman/)._
If you need more info please visit the docs ([https://bcariaga.github.io/buildman/](https://bcariaga.github.io/buildman/))
### Run
Since v 0.5 buildman can run a single request from postman's collection, using a **run** command.
`buildman run "path/to/request/folder"`
### Debug
:construction: **Experimental** :construction:
That feature allows debug by chrome-devtools, works similarity at _Run_ method:
`buildman debug "path/to/request/folder"`
Note: the debug is attached by flag --inspect-brk, you must use a `debug` statement on test or pre scripts.
---
### Have problems by buildman?
Please leave a feedback : https://github.com/bcariaga/buildman/issues/new
---
[](https://nodei.co/npm/@bcariaga/buildman/)
---
Logo made by [Freepik](http://www.freepik.com) from [www.flaticon.com](https://www.flaticon.com/) is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/)