@kingjan1999/rapipdf-cli

```sh-session $ npm install -g @kingjan1999/rapipdf-cli $ rapipdf (-v|--version|version) @kingjan1999/rapipdf-cli/0.0.3 linux-x64 node-v14.15.1 $ rapipdf --help [COMMAND] USAGE $ rapipdf SpecFile # can be either the path to a local file or a remote url (b

0.1.0

latest

Source

npm

Version published: 4 years ago

Maintainers: 1

Created: 5 years ago

Source

Unofficial CLI for RapiPDF

This project is an adaption of RapiPDF providing a CLI for generating PDFs based on OpenAPI specs. Apart from just providing an CLI, some additional configuration options (e.g. adding a logo) are provided.

Usage

$ npm install -g @kingjan1999/rapipdf-cli
$ rapipdf (-v|--version|version)
@kingjan1999/rapipdf-cli/0.0.3 linux-x64 node-v14.15.1
$ rapipdf --help [COMMAND]
USAGE
  $ rapipdf SpecFile # can be either the path to a local file or a remote url (both .yaml and .json are supported)

OPTIONS

  -c, --configFile=configFile # pass the path to the configuration file (optional, see below)
  -o, --outputFile=outputFile # pass the path to the output file (defaults to "api.pdf")

Configuration File

You can pass a configuration file to the CLI (using the -c parameter) overriding the defaults. An example is provided in this repository (rapipdf.config.example-de.json).

Example Usage

Calling

$ rapipdf -o petstore.json.pdf -c config.json  petstore.json

in the examples/ folder results in the uploaded petstore.json.pdf.

Keywords

oclif

FAQs

What is @kingjan1999/rapipdf-cli?

Is @kingjan1999/rapipdf-cli well maintained?

Package last updated on 27 Aug 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install