Command Line Interface Basics

When the Asciidoctor gem is installed successfully, the Asciidoctor command line interface (CLI) will be available on your PATH. To confirm that Asciidoctor is available, execute:

$ asciidoctor --version

The following information should be output in your terminal:

Asciidoctor 1.5.8 [https://asciidoctor.org]

To invoke Asciidoctor from the CLI and convert an .adoc file, execute:

$ asciidoctor <asciidoc_file>

This will use the built-in defaults for options and create a new file in the same directory as the input file, with the same base name, but with the .html extension.

The Command Line Options and Parameters describes the available Asciidoctor CLI options and parameters.

Full help is provided in the Asciidoctor man page or via:

$ asciidoctor --help

Next

Convert your first AsciiDoc file to HTML using the default converter.