# postman-workspace-backup

> This project is designed to download Postman collections from a workspace using the Postman API and save them as JSON files. It provides a convenient way to manage and organize collections for further use. The collections can be merged into a single file

Latest version **1.0.1** (published 2024-02-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install postman-workspace-backup
pnpm add postman-workspace-backup
yarn add postman-workspace-backup
bun add postman-workspace-backup
```

Provides the command `postman-workspace-backup`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2024-02-07 |
| First published | 2023-08-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 28.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | aminefeidi |
| Maintainers | aminefeidi |
| Keywords | postman, download, combine, collection, cli |

## Links

- npm: https://www.npmjs.com/package/postman-workspace-backup
- Repository: https://github.com/aminefeidi/postman-workspace-backup
- Homepage: https://github.com/aminefeidi/postman-workspace-backup#readme
- Issues: https://github.com/aminefeidi/postman-workspace-backup/issues
- npm.io page: https://npm.io/package/postman-workspace-backup

## Dependencies (7)

- [args](https://npm.io/package/args.md) ^5.0.3
- [async](https://npm.io/package/async.md) ^2.6.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.1
- [dateformat](https://npm.io/package/dateformat.md) ^3.0.3
- [cli-progress](https://npm.io/package/cli-progress.md) ^3.12.0
- [node-rest-client](https://npm.io/package/node-rest-client.md) ^3.1.0
- [postman-collection](https://npm.io/package/postman-collection.md) ^4.1.7

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2024-02-07
- 1.0.0 — 2023-08-14

## README

# postman-workspace-backup

This project is designed to download Postman collections from a workspace using the Postman API and save them as JSON files. It provides a convenient way to manage and organize collections for further use. The collections can be merged into a single file for easier import into Postman or for use with CI/CD pipelines using newman.

## Getting Started

To use this project, you need to have Node.js installed on your system. You can download and install Node.js from the [official website](https://nodejs.org/) or use a package manager.

### Installation

Open your terminal and run the following command:

```
npm i -g postman-workspace-backup
```

### Usage

You can run the project using the following command:

```
postman-workspace-backup --api-key YOUR_API_KEY --ws-id WORKSPACE_ID -c
```

Available options:

    -a, --api-key                  The postman API key
    -C, --codify-names             Codify collection names (disabled by default)
    -c, --combine-collections      Combine collections (disabled by default)
    -h, --help                     Output usage information
    -m, --merged-col-name [value]  Change this to the name you want for your output collection (defaults to "merged_collection.json")
    -o, --output-folder [value]    Postman collections folder (defaults to "files/collections")
    -t, --timeout <n>              Delay between api requests (defaults to 300)
    -u, --use-date                 Use date as subfolder (disabled by default)
    -v, --version                  Output the version number
    -w, --ws-id                    Postman workspace id

For example:

```
postman-workspace-backup --api-key YOUR_API_KEY --ws-id WORKSPACE_ID --timeout 300 --use-date --output-folder collections --merged-col-name merged_collection.json --codify-names
```

## License

This project is licensed under the MIT License.

---
_Source: https://npm.io/package/postman-workspace-backup · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._