Erl2ex v0.0.9 Erl2ex.Cli

This module provides the command line interface for the erl2ex binary and the mix erl2ex task.

Summary

Functions

Runs the erl2ex binary, given a set of command line arguments. Does not return. Instead, halts the VM on completion with the appropriate OS result code

run(argv)

Runs the erl2ex binary, given a set of command line arguments. Returns the OS result code, which is 0 for success or nonzero for failure

usage_text(invocation \\ "erl2ex")

Returns the usage documentation for the command line

Functions

main(argv)

Specs

main([String.t]) :: no_return

Runs the erl2ex binary, given a set of command line arguments. Does not return. Instead, halts the VM on completion with the appropriate OS result code.

run(argv)

Specs

run([String.t]) :: non_neg_integer

Runs the erl2ex binary, given a set of command line arguments. Returns the OS result code, which is 0 for success or nonzero for failure.

usage_text(invocation \\ "erl2ex")

Specs

usage_text(String.t) :: String.t

Returns the usage documentation for the command line.

The argument specifies how to invoke the binary (e.g. “erl2ex” or “mix erl2ex”). The returned text is in markdown form, but may be rendered as plain text as well.