Miss any of our Open RFC calls?Watch the recordings here! »

tinyspec-cloud

1.0.1 • Public • Published

Tinyspec Cloud CLI

tinyspec-cloud

NPM version

This CLI allows you to deploy your OpenAPI specification to Tinyspec Cloud and then access its auto-generated versions in different formats (HTML, PDF, YAML, JSON).

Demo

https://wearable-coach.tinyspec.cloud/dev

Quick Start

npm i -g tinyspec-cloud
 
tinyspec-cloud --name my-project

Result example:

🎉 Congratulations!

Your project my-project is created in Tinyspec Cloud.

In a couple of minutes it will be published to these URLs:

https://my-project.tinyspec.cloud
https://my-project.tinyspec.cloud/index.pdf
https://my-project.tinyspec.cloud/openapi.yaml
https://my-project.tinyspec.cloud/openapi.json
https://my-project.tinyspec.cloud/build.log

Please store your access key: XkRTlERUICxnaATXBAH4E9oTwlvD.

If you lose your key, you won't be able to publish updates to your project.

Usage

Options:
  --name    | -n  Project Name (required)
  --version | -v  Project Version
  --key     | -k  Project Secret Key (required for subsequent calls)
  --source  | -s  Source OpenAPI specification file in YAML or JSON format [default: "openapi.yaml"]
  --help    | -h  Show help

You can also set the same options using environment variables prefixed by TINYSPEC_ or in a config file tinyspec.json located in a directory where you run tinyspec-cloud.

More info:

Install

npm i tinyspec-cloud

DownloadsWeekly Downloads

18

Version

1.0.1

License

MIT

Unpacked Size

60.5 kB

Total Files

8

Last publish

Collaborators

  • avatar