Bashly Settings (bashly-settings.yml)
Bashly settings
| Type | object |
|---|---|
| File match |
bashly-settings.yml
bashly-settings.yaml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/bashly-settings-bashly-settings-yml/latest.json |
| Source | https://raw.githubusercontent.com/DannyBen/bashly/master/schemas/settings.json |
Validate with Lintel
npx @lintel/lintel check
Settings of the current application https://bashly.dev/usage/settings/#settings
Properties
The path containing the bashly source files https://bashly.dev/usage/settings/#source_dir
The path to bashly.yml https://bashly.dev/usage/settings/#config_path
The path to use for creating the bash script https://bashly.dev/usage/settings/#target_dir
The path to use for common library files, relative to source_dir https://bashly.dev/usage/settings/#lib_dir
One or more paths to use for common library files, relative to the working directory. May be provided as an array or a comma delimited string. https://bashly.dev/usage/settings/#extra_lib_dirs
The path to use for command files, relative to source_dir https://bashly.dev/usage/settings/#commands_dir
Configure the bash options that will be added to the initialize function https://bashly.dev/usage/settings/#strict
Whether to use tabs or spaces in the generated script https://bashly.dev/usage/settings/#tab_indent
Configure the character width used to wrap help and example messages https://bashly.dev/usage/settings/#word_wrap
Whether to expand -abc to -a -b -c in the input line https://bashly.dev/usage/settings/#compact_short_flags
Whether to expand --flag=value to --flag value in the input line https://bashly.dev/usage/settings/#conjoined_flag_args
Whether to show command examples when the input line is missing required arguments https://bashly.dev/usage/settings/#show_examples_on_error
Whether to include development related comments in the generated script https://bashly.dev/usage/settings/#env
Whether to include the header comment in the generated script https://bashly.dev/usage/settings/#enable_header_comment
Whether to include the code snippet that aborts when an old version of bash is detected in the generated script https://bashly.dev/usage/settings/#enable_bash3_bouncer
Whether to include view marker comments in the generated script https://bashly.dev/usage/settings/#enable_view_markers
Whether to include the inspect_args function in the generated script https://bashly.dev/usage/settings/#enable_inspect_args
Whether to include the code for the dependencies array in the generated script https://bashly.dev/usage/settings/#enable_deps_array
Whether to include the code for the env_var_names array in the generated script https://bashly.dev/usage/settings/#enable_env_var_names_array
Whether to wrap the script execution in a condition that checks if the script is sourced https://bashly.dev/usage/settings/#enable_sourcing
Choose how to post-process the generated script https://bashly.dev/usage/settings/#formatter
The extension to use when reading/writing partial script snippets https://bashly.dev/usage/settings/#partials_extension
The name of the environment variable (case sensitive) that, if set, will reveal private commands, flags and environment variables https://bashly.dev/usage/settings/#private_reveal_key
The name of the environment variable that can override or disable command argfiles at runtime https://bashly.dev/usage/settings/#argfile_var
Whether to use evented file system watch instead of the default polling https://bashly.dev/usage/settings/#watch_evented
The latency in seconds for the file system changes watcher https://bashly.dev/usage/settings/#watch_latency
Enable and configure colorful output for --help https://bashly.dev/usage/settings/#usage_colors
5 nested properties
Declare alias names for bashly's public global arrays https://bashly.dev/usage/settings/#var_aliases
4 nested properties
Alias name for the args array https://bashly.dev/usage/settings/#var_aliases
Alias name for the other_args array (used when catch_all is enabled) https://bashly.dev/usage/settings/#var_aliases
Alias name for the deps array https://bashly.dev/usage/settings/#var_aliases
Alias name for the env_var_names array https://bashly.dev/usage/settings/#var_aliases
Choose different names for some of the internal functions. https://bashly.dev/usage/settings/#function_names
2 nested properties
Name for the run() function https://bashly.dev/usage/settings/#function_names
Name for the initialize() function https://bashly.dev/usage/settings/#function_names