<commit_before>= swagger2markup-cli
Command line interface (CLI) for Swagger2Markup

image:https://travis-ci.org/Swagger2Markup/swagger2markup-cli.svg?branch=master["Build Status", link="https://travis-ci.org/Swagger2Markup/swagger2markup-cli"] image:https://api.bintray.com/packages/swagger2markup/Maven/swagger2markup-cli/images/download.svg[link="https://bintray.com/swagger2markup/Maven/swagger2markup-cli/_latestVersion"]

== Overview

This is a CLI for https://github.com/Swagger2Markup/swagger2markup[Swagger2Markup].
It converts a Swagger JSON or YAML file into several AsciiDoc or GitHub Flavored Markdown documents which can be combined with hand-written documentation. The Swagger source file can be located locally or remotely via HTTP. Swagger2Markup supports the Swagger 1.2 and 2.0 specification.

== Quick usage
You can clone and build the jar, then use this CLI to generate asciidocs.
    
    gradle assemble
    java -jar ./build/libs/swagger2markup-cli-X.X.X.jar convert -i the_swagger_file.json -d /the/path/to/output

That's all! Then you can checkout http://asciidoctor.org/, find your way to to play with asciidocs.

== Reference documentation

The documentation can be found at https://github.com/Swagger2Markup/swagger2markup#reference-documentation[Reference documentation]

== License<commit_msg>Documented Homebrew installation option for Mac users.<commit_after>= swagger2markup-cli
Command line interface (CLI) for Swagger2Markup

image:https://travis-ci.org/Swagger2Markup/swagger2markup-cli.svg?branch=master["Build Status", link="https://travis-ci.org/Swagger2Markup/swagger2markup-cli"] image:https://api.bintray.com/packages/swagger2markup/Maven/swagger2markup-cli/images/download.svg[link="https://bintray.com/swagger2markup/Maven/swagger2markup-cli/_latestVersion"]

== Overview

This is a CLI for https://github.com/Swagger2Markup/swagger2markup[Swagger2Markup].
It converts a Swagger JSON or YAML file into several AsciiDoc or GitHub Flavored Markdown documents which can be combined with hand-written documentation. The Swagger source file can be located locally or remotely via HTTP. Swagger2Markup supports the Swagger 1.2 and 2.0 specification.

== Quick usage
You can clone and build the jar, then use this CLI to generate asciidocs.
    
    gradle assemble
    java -jar ./build/libs/swagger2markup-cli-X.X.X.jar convert -i the_swagger_file.json -d /the/path/to/output

Mac users can use https://brew.sh[Homebrew] to install the Swagger2Markup CLI:

    brew install swagger2markup-cli
    swagger2markup convert -i the_swagger_file.json -d /the/path/to/output

That's all! Then you can checkout http://asciidoctor.org/, find your way to to play with asciidocs.

== Reference documentation

The documentation can be found at https://github.com/Swagger2Markup/swagger2markup#reference-documentation[Reference documentation]

== License
{'fraction_non_alphanumeric': 0.09163484901076015, 'fraction_numerical': 0.015619576535925026, 'mean_word_length': 5.02928870292887, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 13, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7002126', 'n_tokens_mistral': 925, 'n_tokens_neox': 892, 'n_words': 252}