babashka.cli — org.babashka/cli 0.3.33

auto-coerce clj/s

(auto-coerce s)

Auto-coerces s to data. Does not coerce when s is not a string. If s:

• is true or false, it is coerced as boolean
• starts with number, it is coerced as a number (through edn/read-string)
• starts with :, it is coerced as a keyword (through parse-keyword)

coerce clj/s

(coerce s f)

Coerce string s using f. Does not coerce when s is not a string. f may be a keyword (:boolean, :int, :double, :symbol, :keyword) or a function. When f return nil, this is interpreted as a parse failure and throws.

dispatch clj/s

(dispatch table args)

(dispatch table args opts)

Subcommand dispatcher.

Dispatches on first matching command entry in table. A match is determines by whether :cmds, a vector of strings, is a subsequence (matching from the start) of the invoked commands.

Table is in the form:

[{:cmds ["sub_1" .. "sub_n"] :fn f :cmds-opts [:lib]}
 ...
 {:cmds [] :fn f}]

When a match is found, :fn called with the return value of parse-args applied to args enhanced with:

• :dispatch - the matching commands
• :args - concatenation of unparsed commands and args
• :rest-cmds: DEPRECATED, this will be removed in a future version

This function does not throw. Use an empty :cmds vector to always match.

Each entry in the table may have additional parse-args options.

Examples: see README.md.

format-opts clj/s

(format-opts {:keys [spec indent order] :or {indent 2}})

parse-args clj/s

(parse-args args)

(parse-args args opts)

Same as parse-opts but separates parsed opts into :opts and adds :cmds and :rest-args on the top level instead of metadata.

parse-cmds clj/s

(parse-cmds args)

(parse-cmds args {:keys [no-keyword-opts]})

Parses sub-commands (arguments not starting with an option prefix) and returns a map with:

• :cmds - The parsed subcommands
• :args - The remaining (unparsed) arguments

parse-keyword clj/s

(parse-keyword s)

Parse keyword from s. Ignores leading :.

parse-opts clj/s

(parse-opts args)

(parse-opts args opts)

Parse the command line arguments args, a seq of strings. Instead of a leading : either -- or - may be used as well.

Return value: a map with parsed opts.

Additional data such as arguments (not corresponding to any options) are available under the :org.babashka/cli key in the metadata.

Supported options:

• :coerce: a map of option (keyword) names to type keywords (optionally wrapped in a collection.)
• :alias - a map of short names to long names.
• :spec - a spec of options. See spec.
• :restrict - true or coll of keys. Throw on first parsed option not in set of keys or keys of :spec and :coerce combined.
• :require: a coll of options that are required
• :args->opts - consume unparsed commands and args as options

Examples:

(parse-opts ["foo" ":bar" "1"])
;; => {:bar "1", :org.babashka/cli {:cmds ["foo"]}}
(parse-args [":b" "1"] {:aliases {:b :bar} :coerce {:bar parse-long}})
;; => {:bar 1}
(parse-args ["--baz" "--qux"] {:spec {:baz {:desc "Baz"} :restrict true})
;; => throws 'Unknown option --qux' exception b/c there is no :qux key in the spec

spec->opts clj/s

(spec->opts spec)

Converts spec into opts format.