# openapi2curl

> Convert OpenAPI 3.0 to cURL examples

Latest version **0.2.0** (published 2019-08-06) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install openapi2curl
pnpm add openapi2curl
yarn add openapi2curl
bun add openapi2curl
```

Provides the command `openapi2curl`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2019-08-06 |
| First published | 2019-08-06 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.3.0 |
| Dependencies | 5 |
| Unpacked size | 19.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Cristiano Betta @cbetta |
| Maintainers | cbetta |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/openapi2curl
- Repository: https://github.com/box-devrel/openapi2curl
- Issues: https://github.com/box-devrel/openapi2curl/issues
- npm.io page: https://npm.io/package/openapi2curl

## Dependencies (5)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.0
- [@oclif/config](https://npm.io/package/@oclif/config.md) ^1
- [@oclif/command](https://npm.io/package/@oclif/command.md) ^1
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^2
- [@stoplight/json-ref-resolver](https://npm.io/package/@stoplight/json-ref-resolver.md) ^2.1.1

## 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

- 0.2.0 (latest) — 2019-08-06
- 0.1.0 — 2019-08-06

## README

openapi2curl
============

Convert OpenAPI 3.0 to simple cURL examples.

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/openapi2curl.svg)](https://npmjs.org/package/openapi2curl)
[![Downloads/week](https://img.shields.io/npm/dw/openapi2curl.svg)](https://npmjs.org/package/openapi2curl)
[![License](https://img.shields.io/npm/l/openapi2curl.svg)](https://github.com/box-devrel/openapi2curl/blob/master/package.json)

# Installation

```bash
npm install -g openapi2curl
```

# Usage

```bash
USAGE
  $ openapi2curl

OPTIONS
  -h, --help           show CLI help
  -i, --input=input    (required) the input OpenAPI 3.X file
  -o, --output=output  [default: curl.md] the output file to write samples to
  -v, --version        show CLI version
  -x, --hiddenTag      Embed the operateionIDs as hidden comments in the markdown
```

## Examples

Loading from a remote URL:

```bash
openapi2curl -i https://opensource.box.com/box-openapi/openapi.json -o README.md
```

Loading from a local URL:

```bash
openapi2curl -i ./openapi.json -o CURL.md
```

# Limitations

* This project is currently mostly untested. 
* It only works with OpenAPI 3.0 JSON files.
* It does not support splitting the docs into multiple files
* It still has issues with rendering binary content in the request body

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