shake

Releases (4)

• 0.7.0.0 indexed
• 0.6.0.0 unindexed
• 0.5.0.0 unindexed
• 0.4.0.0 unindexed

Definitions (339)

src/cli.bend

• def parse.stepone token
• def parse.walkevery token, in order
• def fill.onea default value kept when the name is not already bound
• def fill.arg.goa Some default is filled when unbound
• def fill.argthis Arg's default, when it has one and is not bound
• def fill.argsdefaults of every spec Arg
• def miss.onea required name that is not bound
• def miss.argwhether this Arg is required and unbound
• def miss.argsthe first required name that is not bound
• def fill.levelseach command's defaults, filled in among its own bindings
• def miss.levelsthe first required argument a command left unbound, in list order
• def level.bindsthe bindings a command made
• def matched.buildeach command's Matched, root first, with the name selected under it
• def parse.finish.missa missing required name, or the matched result
• def parse.finish.okevery command's defaults, then its required arguments, root first
• def parse.finish.modea finished walker: help, a pending value, an error, or defaults + required
• def parse.finishthe walker, finished
• def version.askswhether a word refused at `at` asks for the version: `--version`, or `-V` when the root does not spell `--version`, refused at the root of a spec with a version
• def version.erran error, or a request for the version when it is one
• def version.resa parse's answer, its failure read as a request for the version when it is one
• def parseargv against a Cli
• def version_of.text`name version`, when there is a version
• def version_of.clia spec's `name version`, when it has a version
• def version_of`name version` for a request for the version, of a spec that has one
• def env.get.atthis pair's value when its name matches, else the rest
• def env.getthe value of the first pair named `name`
• def env.fulla value that is not empty
• def env.ofthe env value of an env var: its first pair's value, when that is not empty
• def env.offwhether an env value turns a flag off, as clap's `SetTrue` reads it
• def env.kindthe default an env value gives an argument of this kind: a flag is set unless the value turns it off; every other kind takes the value
• def resolve.witha fallback with its default replaced by what the env value gives, when there is one
• def resolve.argan argument whose default is its fallback under `vars`
• def resolve.argsevery argument's default is its fallback
• def resolve.subsevery argument of every subcommand, its default its fallback
• def resolvethe spec whose every argument's default is its fallback under `vars`
• def env.flag.iswhether this kind is a flag
• def env.bad.valan argument bound to an env value outside its choices: never a flag, and only for a value its command's bindings hold
• def env.bad.argthis argument's name and env value, when its command's bindings hold that value and its choices do not
• def env.firstthe first of two answers that is one
• def env.bad.argsthe first argument of a command bound to an env value outside its choices
• def env.sub.argsthe arguments of a found subcommand, or none
• def env.sub.kidsthe subcommands of a found subcommand, or none
• def env.bad.gothe first argument bound to an env value outside its choices, the command first, then down the selected path
• def env.check.donea success, or the first env value outside its choices that it bound
• def env.check.oka successful parse checked for env values outside their choices
• def env.checka failed parse as it is; a successful one checked for env values outside their choices
• def parse_envargv against a Cli, every argument falling back to its env value under `vars`, then to its default
• def env.names.putan env var in front of the names, when there is one
• def env.names.argsthe env vars of a command's arguments, in order
• def env.names.forestthe env vars of every subcommand's arguments, depth first
• def env.namesthe env vars of a spec: the root's arguments', then every subcommand's
• def help.label.kindthe short/long label of an option, plus a metavar for Opt
• def help.label.pair`-s, --long` or one of them
• def help.labelthe usage label of an option
• def help.extra.goextras after the help string: default and choices
• def help.envthe env var after the help string, before the default
• def help.extraextras after the help string: env var, default and choices
• def help.opt_lineone option line, given the label width
• def help.opt_widththe max option-label width
• def help.opt_lines.ata non-positional option line
• def help.opt_linesoption lines, skipping positionals
• def help.opts.gowrap option lines in a heading
• def help.optsthe Options block, or empty when there are none
• def help.sub_namea command's name
• def help.sub_abouta command's about
• def help.cmd_widthmax command-name width, including `help`
• def help.cmd_lineone command line
• def help.cmd_linescommand lines, then `help`
• def help.cmdsthe Commands block
• def help.pos.dotsa rest mark: `...`, or empty
• def help.pos.wrapa positional in a usage line: `<NAME>` or `[NAME]`
• def help.pos.onea positional in a usage line: `<NAME>` or `[NAME]`, plus `...` when rest
• def help.pos.atthis positional's hint, else the rest
• def help.posevery positional in a usage line
• def help.pos.labela positional's label in the Arguments block: its usage mark without the space before it
• def help.arg_lineone Arguments line, given the label width
• def help.arg_widththe max positional-label width
• def help.arg_lines.ata positional's Arguments line
• def help.arg_linesArguments lines, skipping flags and options
• def help.args.gowrap Arguments lines in a heading
• def help.argsthe Arguments block, or empty when there are no positionals
• def help.opts_hint.gothe bracketed options word when the spec has a flag or option
• def help.has_opt.atTrue when this Arg is a flag or option, else the rest
• def help.has_optwhether any Arg is not a positional
• def help.opts_hintthe options hint when needed
• def help.cmd_hint`[COMMAND]` when there are subcommands
• def help.usage`Usage: name ...`
• def title.go`name` or `name version`
• def help.spella built-in spelling a page lists, unless the command spells it itself
• def help.help_rowthe row for `--help`, and `-h` when the command does not spell it; none when the command spells long `help`
• def help.version_rowthe row for `--version`, and `-V` when the command does not spell it, on a page with a version; none when the command spells long `version`
• def help.builtinsthe built-in flags a page lists after its command's own: help, then the version on the root page
• def help.witha command's arguments, then the built-in flags its page lists
• def help.pageone help page
• def help.step.goa found child becomes the page; an unknown name stays
• def help.stepone path segment against the current page
• def help.gothe page at the end of a shrinking path
• def helpusage for `path` under `app`; an unknown segment shows the last found page
• def usage.gothe usage line of the page at the end of a shrinking path
• def usage.atthe usage line of the command at `path`, as `help` shows it