docopt.core
docoptclj
(docopt doc args)(docopt doc args result-fn)(docopt doc args result-fn usage-fn)Parse argv based on command-line interface described in doc.
docopt creates your command-line interface based on its
description that you pass as doc. Such description can contain
--options, <positional-argument>, commands, which could be
[optional], (required), (mutually | exclusive) or repeated...
This function has multiple arities. The default one is the 2-arity one.
result-fn is a function that will be called with the resulting
map after parsing doc+argv. By default in the 2 arity version
of this function, this will be set to identity function, i.e.:
will return the map without changes.
usage-fn is a function that will be called in case of issues
while parsing, and will receive the doc as argument. By default
in the 2/3 arity version of this function, this will be set to
println, i.e.: it will print the usage of the program and return
nil.
Parse `argv` based on command-line interface described in `doc`. `docopt` creates your command-line interface based on its description that you pass as `doc`. Such description can contain --options, <positional-argument>, commands, which could be [optional], (required), (mutually | exclusive) or repeated... This function has multiple arities. The default one is the 2-arity one. `result-fn` is a function that will be called with the resulting map after parsing `doc`+`argv`. By default in the 2 arity version of this function, this will be set to `identity` function, i.e.: will return the map without changes. `usage-fn` is a function that will be called in case of issues while parsing, and will receive the `doc` as argument. By default in the 2/3 arity version of this function, this will be set to `println`, i.e.: it will print the usage of the program and return `nil`.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close