Bashly (bashly.yml)

Bashly CLI

Type object
File match bashly.yml bashly.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/bashly-bashly-yml/latest.json
Source https://raw.githubusercontent.com/DannyBen/bashly/master/schemas/bashly.json

Validate with Lintel

npx @lintel/lintel check
Type: object

A CLI of the current application https://bashly.dev/usage/getting-started/

Properties

name string

A name of the current script or sub-command https://bashly.dev/configuration/command/#name

Examples: "source"
minLength=1
help string

A description of the current script or sub-command https://bashly.dev/configuration/command/#help

Examples: "URL to download from"
minLength=1
help_header_override string

Bash code (or function call) that will be executed at the beginning of the help message https://bashly.dev/configuration/command/#help-header-override

Examples: "generate_ascii_art_logo"
minLength=1
args argument[]

Arguments of the current script or sub-command https://bashly.dev/configuration/command/#args

minItems=1uniqueItems=true
flags flag[]

Flags of the current script or sub-command https://bashly.dev/configuration/command/#flags

minItems=1uniqueItems=true
commands command-property[]

Subcommands of the current script or sub-command https://bashly.dev/configuration/command/#commands

minItems=1uniqueItems=true
version string

A version of the current script https://bashly.dev/configuration/command/#version

Examples: "0.1.0"
minLength=1
environment_variables environment-variable[]

Environment variables of the current application https://bashly.dev/configuration/environment-variable/#environment-variable

minItems=1uniqueItems=true
variables variable[]

Bash variables for the current application https://bashly.dev/configuration/command/#variables

minItems=1uniqueItems=true
examples string | string[]
catch_all boolean | string | object

Whether to allow additional arguments or flags for the current command https://bashly.dev/configuration/command/#catch_all

completions string[]

Completions of the current script or sub-command https://bashly.dev/configuration/command/#completions

minItems=1uniqueItems=true
dependencies string | null[] | object
extensible boolean | string

Whether to delegate the current unknown command to an external executable https://bashly.dev/configuration/command/#extensible

filename string

A partial file path of the current script or sub-command https://bashly.dev/configuration/command/#filename

Examples: "dir_commands/list.sh"
minLength=1
argfile string

A file containing flag defaults to autoload for the current script or sub-command. Each supported flag must appear on a single line, optionally followed by its value. Non-flag lines are ignored. https://bashly.dev/configuration/command/#argfile

Examples: ".mycli"
minLength=1
filters string[]

Filters of the current script or sub-command https://bashly.dev/configuration/command/#filters

minItems=1
function string

An internal function for the current script or sub-command https://bashly.dev/configuration/command/#function

Examples: "deprecated_container_start"
minLength=1

Definitions

argument object

A positional argument of the current script or sub-command https://bashly.dev/configuration/argument/

name string required

A name of the current positional argument https://bashly.dev/configuration/argument/#name

Examples: "user"
minLength=1
help string

A description of the current positional argument https://bashly.dev/configuration/argument/#help

Examples: "AWS Username"
minLength=1
default string | string[]

A default value of the current positional argument https://bashly.dev/configuration/argument/#default

Examples: "*.jpg"
required boolean

Whether the current positional argument is required https://bashly.dev/configuration/argument/#required

Default: true
allowed string[]

Valid values of the current positional argument https://bashly.dev/configuration/argument/#allowed

minItems=1uniqueItems=true
repeatable boolean

Whether the current positional argument can be repeated https://bashly.dev/configuration/argument/#repeatable

Default: false
validate string | string[]

A validation function of the current positional argument https://bashly.dev/configuration/argument/#validate

Examples: "file_exists", "dir_exists", "integer", "non_empty", ["file_exists","file_writable"]
unique boolean

Whether the current positional argument is unique https://bashly.dev/configuration/argument/#unique

Default: false
flag object

A flag of the current script or sub-command https://bashly.dev/configuration/flag/

long string

A long form of the current flag https://bashly.dev/configuration/flag/#long

Examples: "--ssh"
pattern=^--
short string

A short form of the current flag https://bashly.dev/configuration/flag/#short

Examples: "-s"
pattern=^-[^-]
help string

A description of the current flag https://bashly.dev/configuration/flag/#help

Examples: "Clone using SSH"
minLength=1
arg string

An argument name of the current flag https://bashly.dev/configuration/flag/#arg

Examples: "user"
minLength=1
default string | string[]

A default value of the current flag https://bashly.dev/configuration/flag/#default

Examples: "*.jpg"
required boolean

Whether the current flag is required https://bashly.dev/configuration/flag/#required

Default: true
allowed string[]

Valid values of the current flag https://bashly.dev/configuration/flag/#allowed

minItems=1uniqueItems=true
conflicts string[]

Mutually exclusive flags of the current flag https://bashly.dev/configuration/flag/#conflicts

minItems=1uniqueItems=true
needs string[]

Additional flags required by the current flag https://bashly.dev/configuration/flag/#needs

minItems=1uniqueItems=true
completions string[]

Completions of the current flag https://bashly.dev/configuration/flag/#completions

minItems=1uniqueItems=true
private boolean

Whether the current flag is hidden from help https://bashly.dev/configuration/flag/#private

Default: false
repeatable boolean

Whether the current flag can be repeated https://bashly.dev/configuration/flag/#repeatable

Default: false
validate string | string[]

A validation function of the current flag https://bashly.dev/configuration/flag/#validate

Examples: "file_exists", "dir_exists", "integer", "non_empty", ["file_exists","file_writable"]
unique boolean

Whether the current flag is unique https://bashly.dev/configuration/flag/#unique

Default: false
environment-variable object

An environment variable of the current application https://bashly.dev/configuration/environment-variable/#environment-variable

name string required

A name of the current environment variable https://bashly.dev/configuration/environment-variable/#name

Examples: "config_path"
minLength=1
help string

A description of the current environment variable https://bashly.dev/configuration/environment-variable/#help

Examples: "Location of the config file"
minLength=1
private boolean

Whether the current environment variable is hidden from help https://bashly.dev/configuration/environment-variable/#private

Default: false
required boolean

Whether the current environment variable is required https://bashly.dev/configuration/environment-variable/#required

Default: true
validate string | string[]

A validation function for the current environment variable https://bashly.dev/configuration/environment-variable/#validate

Examples: "file_exists", "dir_exists", "integer", "non_empty", ["file_exists","file_writable"]
allowed string[]

Valid values of the current environment variable https://bashly.dev/configuration/environment-variable/#allowed

minItems=1uniqueItems=true
default string

A default value of the current environment variable https://bashly.dev/configuration/environment-variable/#default

Examples: "~/config.ini"
variable object

A global bash variable https://bashly.dev/configuration/variable/#variable

name string required

A name for the current variable https://bashly.dev/configuration/variable/#name

Examples: "output_dir"
minLength=1
value

A value for the current variable https://bashly.dev/configuration/variable/#value

Examples: "./output", ["development","production"], {"verbosity":3,"debug":true}
name-property string

A name of the current script or sub-command https://bashly.dev/configuration/command/#name

Examples:
  • "source"
sub-command-alias-property string | string[]
help-property string

A description of the current script or sub-command https://bashly.dev/configuration/command/#help

Examples:
  • "URL to download from"
help-header-override-property string

Bash code (or function call) that will be executed at the beginning of the help message https://bashly.dev/configuration/command/#help-header-override

Examples:
  • "generate_ascii_art_logo"
args-property argument[]

Arguments of the current script or sub-command https://bashly.dev/configuration/command/#args

flags-property flag[]

Flags of the current script or sub-command https://bashly.dev/configuration/command/#flags

commands-property command-property[]

Subcommands of the current script or sub-command https://bashly.dev/configuration/command/#commands

root-version-property string

A version of the current script https://bashly.dev/configuration/command/#version

Examples:
  • "0.1.0"
sub-command-default-property boolean | string

Whether to use the current command as a fallback when CLI used incorrectly https://bashly.dev/configuration/command/#default

environment-variables-property environment-variable[]

Environment variables of the current application https://bashly.dev/configuration/environment-variable/#environment-variable

variables-property variable[]

Bash variables for the current application https://bashly.dev/configuration/command/#variables

examples-property string | string[]
sub-command-group-property string

A group of the current sub-command https://bashly.dev/configuration/command/#group

Examples:
  • "File"
catch-all-property boolean | string | object

Whether to allow additional arguments or flags for the current command https://bashly.dev/configuration/command/#catch_all

completions-property string[]

Completions of the current script or sub-command https://bashly.dev/configuration/command/#completions

dependencies-command-property string[]

Dependencies of the current script or sub-command https://bashly.dev/configuration/dependency/#command

dependencies-help-property string

A help for the current dependency https://bashly.dev/configuration/dependency/#help

Examples:
  • "Run 'sudo apt install git'"
dependencies-property string | null[] | object
sub-command-expose-property boolean | string

Whether to expose the current sub-command if it has sub-commands https://bashly.dev/configuration/command/#expose

root-extensible-property boolean | string

Whether to delegate the current unknown command to an external executable https://bashly.dev/configuration/command/#extensible

filename-property string

A partial file path of the current script or sub-command https://bashly.dev/configuration/command/#filename

Examples:
  • "dir_commands/list.sh"
argfile-property string

A file containing flag defaults to autoload for the current script or sub-command. Each supported flag must appear on a single line, optionally followed by its value. Non-flag lines are ignored. https://bashly.dev/configuration/command/#argfile

Examples:
  • ".mycli"
filters-property string[]

Filters of the current script or sub-command https://bashly.dev/configuration/command/#filters

function-property string

An internal function for the current script or sub-command https://bashly.dev/configuration/command/#function

Examples:
  • "deprecated_container_start"
sub-command-private-property boolean

Whether hide the current sub-command from help https://bashly.dev/configuration/command/#private

sub-command-import-property string

A file import for the current sub-command https://bashly.dev/configuration/command/#import

Examples:
  • "src/download_command.sh"
command-property object

A command of the current application https://bashly.dev/configuration/command/#command

name string

A name of the current script or sub-command https://bashly.dev/configuration/command/#name

Examples: "source"
minLength=1
alias string | string[]
help string

A description of the current script or sub-command https://bashly.dev/configuration/command/#help

Examples: "URL to download from"
minLength=1
help_header_override string

Bash code (or function call) that will be executed at the beginning of the help message https://bashly.dev/configuration/command/#help-header-override

Examples: "generate_ascii_art_logo"
minLength=1
args argument[]

Arguments of the current script or sub-command https://bashly.dev/configuration/command/#args

minItems=1uniqueItems=true
flags flag[]

Flags of the current script or sub-command https://bashly.dev/configuration/command/#flags

minItems=1uniqueItems=true
commands command-property[]

Subcommands of the current script or sub-command https://bashly.dev/configuration/command/#commands

minItems=1uniqueItems=true
default boolean | string

Whether to use the current command as a fallback when CLI used incorrectly https://bashly.dev/configuration/command/#default

environment_variables environment-variable[]

Environment variables of the current application https://bashly.dev/configuration/environment-variable/#environment-variable

minItems=1uniqueItems=true
variables variable[]

Bash variables for the current application https://bashly.dev/configuration/command/#variables

minItems=1uniqueItems=true
examples string | string[]
footer string

A description footer for the current script or sub-command https://bashly.dev/configuration/command/#footer

Examples: "This will appear at the end of the --help message"
minLength=1
group string

A group of the current sub-command https://bashly.dev/configuration/command/#group

Examples: "File"
minLength=1
catch_all boolean | string | object

Whether to allow additional arguments or flags for the current command https://bashly.dev/configuration/command/#catch_all

completions string[]

Completions of the current script or sub-command https://bashly.dev/configuration/command/#completions

minItems=1uniqueItems=true
dependencies string | null[] | object
expose boolean | string

Whether to expose the current sub-command if it has sub-commands https://bashly.dev/configuration/command/#expose

filename string

A partial file path of the current script or sub-command https://bashly.dev/configuration/command/#filename

Examples: "dir_commands/list.sh"
minLength=1
argfile string

A file containing flag defaults to autoload for the current script or sub-command. Each supported flag must appear on a single line, optionally followed by its value. Non-flag lines are ignored. https://bashly.dev/configuration/command/#argfile

Examples: ".mycli"
minLength=1
filters string[]

Filters of the current script or sub-command https://bashly.dev/configuration/command/#filters

minItems=1
function string

An internal function for the current script or sub-command https://bashly.dev/configuration/command/#function

Examples: "deprecated_container_start"
minLength=1
private boolean

Whether hide the current sub-command from help https://bashly.dev/configuration/command/#private

Default: false
import string

A file import for the current sub-command https://bashly.dev/configuration/command/#import

Examples: "src/download_command.sh"
minLength=1