https://github.com/cliffano/swaggy-jenkins-cli

CLI utility tool for Swaggy Jenkins library
https://github.com/cliffano/swaggy-jenkins-cli

api-client cli jenkins nodejs

Last synced: 22 days ago
JSON representation

CLI utility tool for Swaggy Jenkins library

• Host: GitHub
• URL: https://github.com/cliffano/swaggy-jenkins-cli
• Owner: cliffano
• License: mit
• Created: 2017-05-11T02:31:47.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2022-10-11T09:32:46.000Z (over 2 years ago)
• Last Synced: 2025-01-05T22:42:14.812Z (about 1 month ago)
• Topics: api-client, cli, jenkins, nodejs
• Language: JavaScript
• Homepage:
• Size: 561 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![Build Status](https://img.shields.io/travis/cliffano/swaggy-jenkins-cli.svg)](http://travis-ci.org/cliffano/swaggy-jenkins-cli)

[![Dependencies Status](https://img.shields.io/david/cliffano/swaggy-jenkins-cli.svg)](http://david-dm.org/cliffano/swaggy-jenkins-cli)

[![Coverage Status](https://img.shields.io/coveralls/cliffano/swaggy-jenkins-cli.svg)](https://coveralls.io/r/cliffano/swaggy-jenkins-cli?branch=master)

[![Published Version](https://img.shields.io/npm/v/swaggy-jenkins-cli.svg)](http://www.npmjs.com/package/swaggy-jenkins-cli)




[![npm Badge](https://nodei.co/npm/swaggy-jenkins-cli.png)](http://npmjs.org/package/swaggy-jenkins-cli)

Swaggy Jenkins CLI

------------------

Swaggy Jenkins CLI is a utility tool for [Swaggy Jenkins](http://github.com/cliffano/swaggy-jenkins) library.

It's used for generating OpenAPI definitions YAML from a set of Jenkins response JSON files for both [Remote Access API](https://wiki.jenkins.io/display/JENKINS/Remote+access+API) and [Blue Ocean API](https://github.com/jenkinsci/blueocean-plugin/tree/master/blueocean-rest).

Installation

------------

    npm install -g swaggy-jenkins-cli

Usage

-----

Generate OpenAPI definitions YAML from a set of Remote Access API's response JSON files under a directory:

    swaggy-jenkins response2definition examples/responses/ --api-type remote-access

Generate definitions from a single response JSON file and write the output to both console and file:

    swaggy-jenkins response2definition examples/responses/getComputer.json --api-type remote-access --reporter console,file --out-file examples/definitions.yml

Colophon

--------

[Developer's Guide](https://cliffano.github.io/developers_guide.html#nodejs)

Build reports:

* [Code complexity report](https://cliffano.github.io/swaggy-jenkins-cli/complexity/plato/index.html)

* [Unit tests report](https://cliffano.github.io/swaggy-jenkins-cli/test/buster.out)

* [Test coverage report](https://cliffano.github.io/swaggy-jenkins-cli/coverage/buster-istanbul/lcov-report/lib/index.html)

* [Integration tests report](https://cliffano.github.io/swaggy-jenkins-cli/test-integration/cmdt.out)

* [API Documentation](https://cliffano.github.io/swaggy-jenkins-cli/doc/dox-foundation/index.html)

Related Projects:

* [swaggy-jenkins](http://github.com/cliffano/swaggy-jenkins) - Generated Jenkins API clients based on OpenAPI spec

* [swaggy-c](http://github.com/cliffano/swaggy-c) - Builder for Swagger CodeGen-generated API clients in multiple languages