For breaking changes, check here.
Babashka CLI: turn Clojure functions into CLIs!
babashka.file) in addition to :prog, so path invocations (e.g. ./script.clj) complete without a :prog-named symlink. --prog may be repeated to register alias names. The program name is no longer restricted to ASCII; non-Latin names are supported.number-char? from the public API, it was accidentally included.
(@lread)scratch.clj from released jardispatch now accepts a tree directly (as returned by table->tree). See Tree formatdispatch CLIs (bash/zsh/fish/powershell/nushell): subcommands, options, option and positional values, and file arguments. Based on initial work from 2024 by @sohalt. See Completions:no-doc now hides a spec option too, not just a subcommand. See Subcommands--opt=val splits on the first = only: --header=k=v parses as "k=v" (everything after the second = was dropped before). --opt= now parses as an explicit empty-string value instead of a flag--help for dispatch CLIs (Usage / Commands / Options, --help/-h on every (sub)command, terse errors). See Helpformat-opts two-column help layout, plus terminal-width description wrapping. See Printing options and Terminal width:inherit in dispatch: an option usable before or after its subcommand. See Subcommands:restrict no longer flags :exec-args keys or parent-level options. See RestrictMissing value for option --fooopts->table accepts :columns to override auto-detected columns (@jeeger)parse-opts*: parses args to raw map, no coercion / defaults / validationcoerce-opts: standalone coerce stepvalidate-opts: standalone :restrict / :require / :validate stepapply-defaults: fills missing keys from :exec-args or spec :default:implicit-true true when the failure was an implicit --foo with no value- value accidentally parsed as option, e.g. --file -:repeated-opts option to enforce repeating the option for accepting multiple
values (e.g. --foo 1 --foo 2 rather than --foo 1 2)pom.xml and project.clj for cljdoc:collect option to support custom transformation of arguments to collections (@lread):collect in :specformat-table correctly pads cells containing ANSI escape codesFix #89: long option never represents alias
Fix #82: prefer alias over composite option
:opts to :error-fn input--dirs, --only, etc--no-option (--no prefix) in combination with subcommands:exec-args over spec :defaultsdispatch improvements (@Sohalt, @borkdude):
:cmds order of entries in the table doesn't matterfoo --opt1=never bar --opt2=always-X and -T behavior-abc => {:a true :b true :c true}--no- prefix for negative flags: --no-colors => {:colors false}auto-coerce: coerce "nil" to nil (@teodorlu)auto-coerce for keywords (@teodorlu)babashka.exec compatible with clojure CLI 1.11.1.1152+:exec-args should be replaced, not merged:org.babashka/cli {:exec true} to arg map's metadata when invoking
functions with babashka.cli.exec.:exec-fn on command line:exec-args with false defaultclojure.basis:error-fn to handle errors (@jmglov):spec options with additional "terse" options:require to throw on missing options:validate to throw on invalid optionsparse-opts options in dispatch table entries:args->opts in parse-opts to consume positional arguments as options:aliases to :alias (with backwards compatibility):closed to :restrict (with backwards compatibility):cmds-opts to args->opts (with backwards compatibility):closed in parse-args / parse-opts for throwing on unrecognized
options.babashka.cli.exec for babashka:foo and foo as string to be coerced into :foo keyword.cli/auto-coerce should not coerce when input is not a stringcli/auto-coerce:default in :specformat-opts output.:spec.format-opts for help output + spec format:args. See docs.:no-keyword-opts to treat :foo as option value rather than option namenil to be a valid coerced value:coerce option now supports a collection and type: [:keyword] which
makes :collect redundant and henceforth deprecated. The shorthand
:keywords introduced in v0.2.16 is removed (breaking).:coerce + :collect shorthands:ns-default in deps alias:exec-fn in deps alias:exec-args on ns metadata:exec-args in parse options to provide defaultsparse-opts which replaces parse-args and returns a single map.:org.babashka/cli options in deps.edn aliases.:exec-args in aliasexec--foo=bar syntaxorg.babashka/cli:collect option for collecting values into collectiontrue options without explicit boolean value and coercion:aliasescoerce: ``:boolean,:int,:double,:symbol,:keyword`--foo and -foo as syntax sugar for :fooInitial release
:input and :coerce-fn keys in its ex-data. See the "Error handling"
section in the README for details on the new exception format.:keywords introduced in v0.2.16 is removed
(breaking).Can you improve this documentation? These fine people already did:
Michiel Borkent, Lee Read, Gert Goet, Josh Glover, Teodor Heggelund & Josh Glover [He/Him]Edit on GitHub
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |