clj-cli-ext.core — clj-cli-ext 0.1.1

An extension of clojure.tool.cli to simplify command line parsing.

add-action clj

(add-action cli key-vector)

Put the parsed options into the tree.

add-default-globals clj

(add-default-globals cli options)

add the global options (--version --help) in.

add-parsed-options clj

(add-parsed-options cli options key-vector)

Put the parsed options into the tree.

change-usage clj

(change-usage cli usage-function)

Set your own usage function if you really want to.

do-parse clj

(do-parse args
          parse-group
          {:keys [pname version description exception]
           :or {pname "test"
                version "1.0.0"
                description "This test program does nothing."
                exception :none}})

error-exit clj

(error-exit cli errors)

Set the proper error message and throw an exception.

error-msg clj

(error-msg cli errors)

Build a nice error message.

exit-condition clj

(exit-condition cli group-name parser options errors & rest)

Check for errors, --version and --help. If any of the above do the right thing and throw an exception

exit-on-exception clj

(exit-on-exception cli setting)

Set behavior to system exit on error, help or version. true or nil.

get-help-tree clj

(get-help-tree cli group-name parser)

get-summary-entry clj

(get-summary-entry tree)

handle-catch clj

(handle-catch cli e)

help-complete clj

(help-complete cli group-name parser)

help-entry clj

(help-entry entry)

help-group clj

(help-group group)

help-header clj

(help-header cli)

Build the program's help header.

help-summary clj

(help-summary cli)

Create a summary of the command line for the program.

help-tree-entry clj

(help-tree-entry name parse-entry)

create a help tree node from a parse tree node.

help-tree-group clj

(help-tree-group parse-group)

process the entries in a parse group to create help nodes.

new-cli clj

(new-cli name version description)

Initialize the command line interface map.

new-main-parser clj

(new-main-parser cli options parse-groups)

Create the main cli parser

on-exception clj

(on-exception cli setting)

Set behavior for exception handling. :exit :throw or :none. Behavior applies to --help, --version and errors.

parse clj

(parse cli argv)

Parse the arguments and fill in the cli map. Handle --help, --version and parsing errors.

parse-group clj

(parse-group cli key-vector parse-group arguments)

Iterate over a parse group and parse the options and sub-parse-groups.

parse-group-entries clj

(parse-group-entries cli key-vector parsers arguments)

loop through non sub-command group of parser entries.

parse-group-entry clj

(parse-group-entry cli key-vector group-name parser arguments)

Parse argumens with an entry from parse-group for its options and recurse through it's parse-groups.

parse-options clj

(parse-options cli key-vector argv options group-name parser)

Parse the options for the current parser.

parse-subcommand clj

(parse-subcommand cli key-vector parse-group arguments)

summarize-entry clj

(summarize-entry entry)

summarize-entry2 clj

(summarize-entry2 parent entry)

summarize-entry3 clj

(summarize-entry3 parent entry)

summarize-group clj

(summarize-group group)

summarize-group2 clj

(summarize-group2 parent group)

summary clj

(summary option-spec)

throw-on-exception clj

(throw-on-exception cli setting)

Set behavior to throw exception on error, help or version. true or nil.

unrecognized-options clj

(unrecognized-options cli argv)

When we have leftovers.

usage clj

(usage cli summary group-name parser)

Basic help for the program.

usage-exit clj

(usage-exit cli)

(usage-exit cli summary)

(usage-exit cli group-name parser summary)

Set the proper usage message and throw an exception.