@bcariaga/buildman

0.5.3 • Public • Published

buildman version Build Status codecov GitHub license

logo

A tool for making files from a Postman Collection and vice versa

Docs:

https://bcariaga.github.io/buildman/

Getting Started

buildman was created on Node.js. To use buildman, you need have Node.js 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.

If you need more info please visit the docs (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

🚧 Experimental 🚧

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


NPM


Logo made by Freepik from www.flaticon.com is licensed by CC 3.0 BY

Readme

Keywords

Package Sidebar

Install

npm i @bcariaga/buildman

Weekly Downloads

12

Version

0.5.3

License

MIT

Unpacked Size

102 kB

Total Files

24

Last publish

Collaborators

  • bcariaga