GitHub - SixArm/unix-shell-script-kit: Unix shell script kit with many utility functions, exit codes, color codes, assertion texting, and POSIX helpers.

Unix shell script kit

Unix shell script kit is a collection of utility functions and constants.

The kit works with POSIX shells, including bash, zsh, dash, ksh, sh, etc.

All suggestions are welcome and appreciated.

View the source code file with all documentation comments

Documentation:

• Functions
• Color codes
• Exit codes
• Assert testing

Download

Download the kit as one file that has everything:

curl -O "https://raw.githubusercontent.com/SixArm/unix-shell-script-kit/main/unix-shell-script-kit"

Source

To use the kit in your own script, you source the kit like this:

. /your/path/here/unix-shell-script-kit

To use the kit in your own script in the same directory, you source the kit like this:

. "$(dirname "$(readlink -f "$0")")/unix-shell-script-kit"

AI

This work is 100% by humans. If you want to use this kit with your AI, then you can download AI-friendly files.

• If your AI is small, then download llms-small.txt

• If your AI is large, then download llms-large.txt

Overview

Overview of the functions, color codes, exit codes, and assert testing. For more information please see the source

Functions:

• color -> true or false
• out -> message
• err -> message
• die
• big
• zid -> <32-bit secure random lowercase hex identifier>
• ask ->
• utf8 -> true or false
• print_success
• print_warning
• print_failure
• now ->
• now_date ->
• sec ->
• age ->
• age_lt -> true or false
• age_gt -> true or false
• leap_year -> true or false
• datetime_mday_max <datetime | yyyy-mm*> -> true or false
• datetime_format_for_at_command -> <yyyymmdddhhmm.ss>
• datetime_format_for_pmset_command -> <mm/dd/yy hh:mm:ss>
• datetime_add ->
• directory_exists <directory_path> -> true or false
• directory_exists_or_die <directory_path> -> true or die
• file_exists <file_path> -> true or false
• file_exists_or_die <file_path> -> true or die
• symlink_exists <symlink_path> -> true or false
• symlink_exists_or_die <symlink_path> -> true or die
• command_exists <command_name> -> true or false
• command_exists_or_die <command_name> -> true or die
• command_version_exists <command_name> <version_actual> <version_minimum> -> true or false
• command_version_exists_or_die <command_name> <version_actual> <version_minimum> -> true or die
• var_exists <var_name> -> true or false
• var_exists_or_die <var_name> -> true or die
• version <version_actual> <version_minimum> -> true or false
• version_or_die <version_actual> <version_minimum> -> true or die
• int <number_string> -> integer
• sum ... -> sum of numbers
• cmp_alnums <alnum_string> <alnum_string> -> 0 or -1 or 1
• cmp_digits <digits_string> <digits_string> -> 0 or -1 or 1
• dot_all <directory_path> -> source all executable files
• run_all <directory_path> -> run all executable files
• sh_all <directory_path> -> shell all executable files
• rm_all <directory_path> -> remove all files
• trim -> string without leading/trailing spaces
• slug -> string with solely lowercase and single internal dash characters
• slugs -> string with solely lowercase and single internal dash characters and slash characters
• upper_case -> string with uppercase not lowercase
• lower_case -> string with lowercase nor uppercase
• kebab_case -> string with solely alphanumeric and single internal dash characters
• snake_case -> string with solely alphanumeric and single internal underscore characters
• space_case -> string with solely solely alphanumeric and single internal space characters
• touch_case -> string with solely a command "touch -t" timestamp format
• select_character_class [offset [length]] -> selected characters
• reject_character_class [offset [length]] -> rejected characters
• random_char [characters [length]] -> random characters
• random_char_alnum [length] -> random characters in class [:alnum:]
• random_char_alpha [length] -> random characters in class [:alpha:]
• random_char_blank [length] -> random characters in class [:blank:]
• random_char_cntrl [length] -> random characters in class [:cntrl:]
• random_char_digit [length] -> random characters in class [:digit:]
• random_char_graph [length] -> random characters in class [:graph:]
• random_char_lower [length] -> random characters in class [:lower:]
• random_char_lower_digit [length] -> random characters in classes [:lower:][:digit]
• random_char_upper [length] -> random characters in class [:upper:]
• random_char_upper_digit [length] -> random characters in classes [:upper:][:digit]
• random_char_space [length] -> random characters in class [:space:]
• random_char_xdigit [length] -> random characters in class [:xdigit:]
• array_n -> number of fields
• array_i -> array element at index
• array_first -> array first element
• array_last -> array last element
• array_car -> array car element
• array_cdr -> array cdr elements
• mktemp_dir -> temporary directory path
• mktemp_file -> temporary file path
• file_media_type <file_path> -> media type
• file_media_type_supertype <file_path> -> media type supertype
• file_media_type_subtype <file_path> -> media type subtype
• font_name_exists <font_name> -> true or false
• font_name_exists_or_die <font_name> -> true or die
• file_ends_with_newline <file_path> -> true or false
• user_dir <directory_locator> -> directory path