Bash API

Generated from public function usage comments in clyops.sh.

`info`

Usage: info <message...>. Log an informational message to stderr.

`warn`

Usage: warn <message...>. Log a warning to stderr.

`error`

Usage: error <message...>. Log an error to stderr.

`success`

Usage: success <message...>. Log a success message to stderr.

`die`

Usage: die <exit_code>

`clyops_name`

Usage: clyops_name . Set the program name for help and completion.

`clyops_root`

Usage: clyops_root . Set the base for default and environment paths.

`clyops_description`

Usage: clyops_description . Set the description below the usage line.

`clyops_epilog`

Usage: clyops_epilog . Set the final help text.

`clyops_command`

Usage: clyops_command " [...]" Registers a command (spec section 1.7); later registrations belong to it. "db migrate" is the migrate command of db, which must be registered first.

`clyops_effects`

Usage: clyops_effects ... (read-only, idempotent, destructive, network)

`clyops_stdin`

Usage: clyops_stdin [content-type] / clyops_stdout [content-type]

`clyops_stdout`

Usage: clyops_stdout [content-type]. Declare output metadata.

`clyops_exclusive`

Usage: clyops_exclusive ... / clyops_requires ... / clyops_one_of ...

`clyops_requires`

Usage: clyops_requires <long...>. The first option requires the others.

`clyops_one_of`

Usage: clyops_one_of <long...>. Require at least one listed option.

`clyops_config`

Usage: clyops_config <prefix[,prefix...]>

`clyops_require_command`

Usage: clyops_require_command [install-hint]

`clyops_path_search`

Usage: clyops_path_search <dir[:dir...]> (dirs relative to the root)

`clyops_opt`

Usage: clyops_opt <default|flag|optional|""> [group] [rule]

`clyops_opt_array`

Usage: clyops_opt_array [group] [rule]

`clyops_arg`

Usage: clyops_arg [default] [rule]

`clyops_arg_variadic`

Usage: clyops_arg_variadic [rule]

`clyops_parse`

Parse without exiting. Returns 0 when values were assigned; otherwise _CLYOPS_HELP is set (help requested) or _CLYOPS_ERROR holds the message.

`clyops_run`

Parse like a CLI: handles --help, --help-json-schema and --bash-completion, prints errors and exits on failure, otherwise assigns the variables.

`clyops_source`

Print where an option's value came from: cli, config, env, default or unset.

`clyops_is_set`

Usage: clyops_is_set . Return zero if the option came from CLI, else one.

`clyops_is_explicitly_set`

Usage: clyops_is_explicitly_set . Return zero for CLI/config/env, else one.

`clyops_values_json`

Resolved values as JSON (spec section 10).

`clyops_usage`

Help text (spec section 7), for the selected command.

`clyops_json_schema`

JSON description of the CLI (spec section 8).

`clyops_completion_data`

Tab-separated completion records (spec section 9). The arguments are the words typed after the program name; a program with commands follows them.

`clyops_completion_script`

Print a script that enables completion for this program in bash, zsh or fish (spec section 9): eval "$(prog --completion bash)". Returns 1 for an unknown shell.