All functions

All functions in Zesk Build, alphabetically.

🛠️ Tools · ⬅ Top

---

• JSON - Format something neatly as JSON (source)

• alignLeft - align text left (source)

• alignRight - align text right (source)

• allColorTest - DEPRECATED 2025-07-16 (source)

• alpineContainer - Open an Alpine container shell (source)

• anyEnvToBashEnv - DEPRECATED 2025-07-23 (source)

• anyEnvToDockerEnv - DEPRECATED 2025-07-23 (source)

• apkIsInstalled - Is this an Alpine system and is apk installed? (source)

• applicationHome - Set, or cd to current application home directory. (source)

• applicationHomeAliases - Set aliases G and g default for applicationHome (source)

• approveBashSource - Loads files or a directory of .sh files using source (source)

• approvedSources - List approved Bash script sources which can be loaded automatically (source)

• aptIsInstalled - Is apt-get installed? (source)

• aptKeyAdd - Add keys to enable apt to download terraform directly from (source)

• aptKeyAddHashicorp - Add keys to enable apt to download terraform directly from (source)

• aptKeyAddOpenTofu - Add keys to enable apt to download tofu directly from (source)

• aptKeyRemove - Remove apt keys (source)

• aptKeyRemoveHashicorp - Add keys to enable apt to download terraform directly from (source)

• aptKeyRemoveOpenTofu - Add keys to enable apt to download tofu directly from (source)

• aptKeyRingDirectory - Get key ring directory path (source)

• aptNonInteractive - Run apt-get non-interactively (source)

• aptSourcesDirectory - Get APT source list path (source)

• awsCredentialsAdd - Write an AWS profile to the AWS credentials file (source)

• awsCredentialsFile - Get the path to the AWS credentials file (source)

• awsCredentialsFromEnvironment - Write an AWS profile to the AWS credentials file (source)

• awsCredentialsHasProfile - Get credentials and output environment variables for AWS authentication (source)

• awsCredentialsRemove - Remove credentials from the AWS credentials file (source)

• awsEnvironmentFromCredentials - Get credentials and output environment variables for AWS authentication (source)

• awsHasEnvironment - Test whether the AWS environment variables are set or not (source)

• awsIPAccess - Grant access to AWS security group for this IP only using Amazon IAM credentials (source)

• awsInstall - aws Command-Line install (source)

• awsIsKeyUpToDate - Test whether the AWS keys do not need to be updated (source)

• awsProfilesList - List AWS profiles available in the credentials file (source)

• awsRegionValid - Check an AWS region code for validity (source)

• awsS3DirectoryDelete - Delete a directory remotely on S3 (source)

• awsS3Upload - Upload a set of files or directories to S3. (source)

• awsSecurityGroupIPModify - Modify an EC2 Security Group (source)

• backgroundProcess - Background process manager for shell (UNSTABLE) (source)

• bashBuiltins - List bash buildin functions, one per line (source)

• bashCheckRequires - Checks a bash script to ensure all requirements are met, (source)

• bashCommentFilter - Filter comments from a bash stream (source)

• bashCoverage - Collect code coverage statistics for a code sample (source)

• bashCoverageReport - Generate a coverage report using the coverage statistics file (source)

• bashDebug - Simple debugger to walk through a program (source)

• bashDebugInterruptFile - Adds a trap to capture the debugging stack on interrupt (source)

• bashDebuggerDisable - Disables the debugger immediately (source)

• bashDebuggerEnable - Enables the debugger immediately (source)

• bashDocumentationExtract - Generate a set of name/value pairs to document bash functions (source)

• bashFileComment - Extract a bash comment from a file. Excludes lines containing (source)

• bashFinalComment - Extracts the final comment from a stream (source)

• bashFunctionComment - Extract a bash comment from a file. Excludes lines containing (source)

• bashFunctionCommentVariable - Gets a list of the variable values from a bash (source)

• bashFunctionDefined - Is a function defined in a bash source file? (source)

• bashGetRequires - Gets a list of the Requires: comments in a bash (source)

• bashLibrary - Run or source a library (source)

• bashLibraryHome - Output the home for a library in the parent path (source)

• bashLint - Run shellcheck and bash -n on a set of bash (source)

• bashLintFiles - Check files for the existence of a string (source)

• bashLintFilesInteractive - Run checks interactively until errors are all fixed. (source)

• bashListFunctions - List functions in a given shell file (source)

• bashPrompt - Bash prompt creates the PS1 prompt with the following extra (source)

• bashPromptColorScheme - Color schemes for prompts (source)

• bashPromptColorsFormat - Given a list of color names, generate the color codes (source)

• bashPromptMarkers - Set markers for terminal integration (source)

• bashPromptModule_dotFilesWatcher - Watches your HOME directory for . files which are added (source)

• bashRecursionDebug - Place this in code where you suspect an infinite loop (source)

• bashSanitize - Sanitize bash files for code quality. (source)

• bashShowUsage - Show function handler in files (source)

• bashSourcePath - Load a directory of bash scripts (source)

• bashStripComments - Pipe to strip comments from a bash file (source)

• bashUserInput - Prompt the user properly honoring any attached console. (source)

• beginsWith - Return Code: 0 - If text has any prefix (source)

• betterType - DEPRECATED 2025-07-07 (source)

• bigText - Display large text in the console for banners and important (source)

• bigTextAt - Experimental (source)

• bitbucketContainer - Return Code: 1 - If already inside docker, or the (source)

• bitbucketGetVariable - Fetch a value from the pipelines YAML file (source)

• bitbucketPRNewURL - Compute the URL to create a new PR (source)

• booleanChoose - Boolean selector (source)

• boxedHeading - Text heading decoration (source)

• brewInstall - Install Homebrew (source)

• buildCacheDirectory - Path to cache directory for build system. (source)

• buildCompletion - Add completion handler for Zesk Build to Bash (source)

• buildDebugEnabled - Is build debugging enabled? (source)

• buildDebugStart - Start build debugging if it is enabled. (source)

• buildDebugStop - Stop build debugging if it is enabled (source)

• buildDevelopmentLink - Add a development link to the local version of Zesk (source)

• buildEnvironmentContext - Run a command and ensure the build tools context matches (source)

• buildEnvironmentFiles - Determine the environment file names for environment variables (source)

• buildEnvironmentGet - Load and print one or more environment settings (source)

• buildEnvironmentGetDirectory - Load and print one or more environment settings which represents (source)

• buildEnvironmentLoad - Load one or more environment settings from the environment file (source)

• buildFailed - Output debugging information when the build fails (source)

• buildFunctions - Prints the list of functions defined in Zesk Build (source)

• buildHome - Prints the build home directory (usually same as the application (source)

• buildQuietLog - Generate the path for a quiet log in the build (source)

• cachedShaPipe - SHA1 checksum of standard input (source)

• cannon - Replace text fromText with toText in files, using findArgs to (source)

• catchArgument - Run command, upon failure run handler with an argument error (source)

• catchCode - Run command, handle failure with handler with code and command (source)

• catchEnvironment - Run command, upon failure run handler with an environment error (source)

• catchEnvironmentQuiet - Run handler with an environment error (source)

• catchReturn - Run binary and catch errors with handler (source)

• characterClassReport - Write a report of the character classes (source)

• characterClasses - List the valid character classes allowed in isCharacterClass (source)

• characterFromInteger - Given a list of integers, output the character codes associated (source)

• characterToInteger - Convert one or more characters from their ascii representation to (source)

• checkDockerEnvFile - DEPRECATED 2025-07-29 (source)

• clampDigits - Clamp digits between two integers (source)

• clearLine - Clear a line in the console (source)

• colorBrightness - Return an integer between 0 and 100 (source)

• colorComboTest - DEPRECATED 2025-07-16 (source)

• colorFormat - Take r g b decimal values and convert them to (source)

• colorMultiply - Multiply color values by a factor and return the new (source)

• colorNormalize - Redistribute color values to make brightness adjustments more balanced (source)

• colorParse - Parse a color and output R G B decimal values (source)

• colorSampleCodes - Alternate color output (source)

• colorSampleCombinations - Show combinations of foreground and background colors in the console. (source)

• colorSampleSemanticStyles - Output colors (source)

• colorSampleStyles - Output colors (source)

• colorScheme - Set the terminal color scheme to the specification (source)

• colorTest - DEPRECATED 2025-07-16 (source)

• confirmMenu - Ask the user for a menu of options (source)

• confirmYesNo - Read user input and return success on yes (source)

• consoleBrightness - Fetch the brightness of the console using consoleGetColor (source)

• consoleColorMode - Set colors to deal with dark or light-background consoles (source)

• consoleColumns - Column count in current console (source)

• consoleConfigureColorMode - Print the suggested color mode for the current environment (source)

• consoleDefaultTitle - Set the title of the window for the console to (source)

• consoleFileLink - Output a local file link to the console (source)

• consoleGetColor - Get the console foreground or background color (source)

• consoleLink - Output a hyperlink to the console (source)

• consoleLinksSupported - Are console links (likely) supported? (source)

• consoleRows - Row count in current console (source)

• consoleSetTitle - Set the title of the window for the console (source)

• contextOpen - Open a file in a shell using the program we (source)

• contextShow - Show the current editor being used as a text string (source)

• convertValue - map a value from one value to another given from-to (source)

• copyFile - DEPRECATED 2025-07-23 (source)

• copyFileWouldChange - DEPRECATED 2025-07-23 (source)

• crontabApplicationUpdate - Application-specific crontab management (source)

• cursorGet - Get the current cursor position (source)

• cursorSet - Move the cursor to x y (source)

• daemontoolsExecute - Launch the daemontools daemon (source)

• daemontoolsHome - Print the daemontools service home path (source)

• daemontoolsInstall - Install daemontools and dependencies (source)

• daemontoolsInstallService - Install a daemontools service which runs a binary as the (source)

• daemontoolsIsRunning - Is daemontools running? (source)

• daemontoolsManager - Runs a daemon which monitors files and operates on services. (source)

• daemontoolsProcessIds - List any processes associated with daemontools supervisors (source)

• daemontoolsRemoveService - Remove a daemontools service by name (source)

• daemontoolsRestart - Restart the daemontools processes from scratch. (source)

• daemontoolsTerminate - Terminate daemontools as gracefully as possible (source)

• darwinDialog - Display a dialog using osascript with the choices provided. Typically (source)

• darwinNotification - Display a notification for the user (source)

• darwinSoundDirectory - Directory for user sounds (source)

• darwinSoundInstall - Install a sound file for notifications (source)

• darwinSoundNames - List valid sound names usable for notifications in Darwin (source)

• darwinSoundValid - Is a Darwin sound name valid? (source)

• dateAdd - Add or subtract days from a text date (source)

• dateFromTimestamp - Converts an integer date to a date formatted timestamp (e.g. (source)

• dateToFormat - Platform agnostic date conversion (source)

• dateToTimestamp - Converts a date to an integer timestamp (source)

• dateValid - Is a date valid? (source)

• debugOpenFiles - Output current open files (source)

• debuggingStack - Dump the function and include stacks and the current environment (source)

• decorate - Singular decoration function (source)

• decoratePath - Display file paths and replace prefixes with icons (source)

• decorateStyle - Fetch (source)

• decorations - Output a list of build-in decoration styles, one per line (source)

• deployApplication - Deploy an application from a deployment repository (source)

• deployApplicationVersion - Extracts version from an application either from .deploy files or (source)

• deployBuildEnvironment - Deploy to a host (source)

• deployHasVersion - Does a deploy version exist? versionName is the version identifier (source)

• deployLink - Link deployment to new version of the application (source)

• deployMigrateDirectoryToLink - Automatically convert application deployments using non-links to links. (source)

• deployMove - Safe application deployment by moving (source)

• deployNextVersion - Get the next version of the supplied version (source)

• deployPackageName - Outputs the build target name which is based on the (source)

• deployPreviousVersion - Get the previous version of the supplied version (source)

• deployRemoteFinish - This is run on the remote system after deployment; environment (source)

• deployToRemote - Deploy current application to host at applicationPath. (source)

• deprecatedCannon - undocumented (source)

• deprecatedCannonFile - Run cannon using a configuration file or files. (source)

• deprecatedFilePrependVersion - Take a deprecated.txt file and add a comment with the (source)

• deprecatedFind - Find files which match a token or tokens (source)

• deprecatedIgnore - Output a list of tokens for find to ignore in (source)

• deprecatedTokensFile - Run deprecated tokens file search (source)

• developerAnnounce - Announce a list of functions now available (source)

• developerDevelopmentLink - Link a current library with another version being developed nearby (source)

• developerTrack - Track changes to the bash environment. WIth no arguments this (source)

• developerUndo - Undo a set of developer functions or aliases (source)

• directoryChange - Run a command after changing directory to it and then (source)

• directoryClobber - Copy directory over another sort-of-atomically (source)

• directoryIsEmpty - Does a directory exist and is it empty? (source)

• directoryNewestFile - Find the newest modified file in a directory (source)

• directoryOldestFile - Find the oldest modified file in a directory (source)

• directoryParent - Finds a file above startingDirectory, uses testExpression to test (defaults (source)

• directoryPathSimplify - Normalizes segments of /./ and /../ in a path without (source)

• directoryRelativePath - Given a path to a file, compute the path back (source)

• directoryRequire - Given a list of directories, ensure they exist and create (source)

• dockerCompose - docker compose wrapper with automatic .env support (source)

• dockerComposeCommandList - List of docker compose commands (source)

• dockerComposeInstall - Install docker-compose (source)

• dockerComposeIsRunning - Is docker compose currently running? (source)

• dockerComposeUninstall - Install docker-compose (source)

• dockerComposeWrapper - Wrapper for docker-compose or docker compose (source)

• dockerEnvFromBashEnv - DEPRECATED 2025-07-23 (source)

• dockerEnvToBash - DEPRECATED 2025-07-23 (source)

• dockerImages - List docker images which are currently pulled (source)

• dockerListContext - List the files which would be included in the docker (source)

• dockerLocalContainer - Run a build container using given docker image. (source)

• dockerPlatformDefault - Fetch the default platform for docker (source)

• dockerVolumeDelete - Delete a docker volume (source)

• dockerVolumeExists - Does a docker volume exist with name? (source)

• documentationBuild - Build documentation for Bash functions (source)

• documentationBuildCache - Get the cache directory for the documentation (source)

• documentationBuildEnvironment - Build documentation for ./bin/env (or bin/build/env) directory. (source)

• documentationIndexDocumentation - Generate the documentation index (e.g. functions defined in the documentation) (source)

• documentationIndexLookup - Looks up information in the function index (source)

• documentationMkdocs - Build documentation using mkdocs and a template (source)

• documentationTemplate - Get an internal template name (source)

• documentationTemplateCompile - Convert a template file to a documentation file using templates (source)

• documentationTemplateDirectoryCompile - Convert a directory of templates into documentation for Bash functions (source)

• documentationTemplateFunctionCompile - Generate a function documentation block using functionTemplate for functionName (source)

• documentationTemplateUpdate - Map template files using our identical functionality (source)

• documentationUnlinked - List unlinked functions in documentation index (source)

• dotEnvConfigure - Load .env and optional .env.local into bash context (source)

• dotFilesApproved - Lists of dot files which can be added to the (source)

• dotFilesApprovedFile - The dot files approved file. Add files to this to (source)

• dumpBinary - Dumps output as hex (source)

• dumpDockerTestFile - Debugging, dumps the proc1file which is used to figure out (source)

• dumpEnvironment - Output the environment but try to hide secure value (source)

• dumpEnvironmentUnsafe - Output the environment shamelessly (not secure, not recommended) (source)

• dumpFile - Output a file for debugging (source)

• dumpHex - Output to hex (source)

• dumpLoadAverages - Print the load averages (source)

• dumpPipe - Dump a pipe with a title and stats (source)

• echoBar - Output a bar as wide as the console (source)

• environmentAddFile - Adds an environment variable file to a project (source)

• environmentApplicationLoad - Loads application environment variables, set them to their default values (source)

• environmentApplicationVariables - List environment variables related to application deployments (source)

• environmentClean - Clean most exported variables from the current context except a (source)

• environmentCompile - Load an environment file and evaluate it using bash and (source)

• environmentFileApplicationMake - Create environment file .env for build. (source)

• environmentFileApplicationVerify - Check application environment is populated correctly. (source)

• environmentFileBashCompatibleToDocker - Ensure an environment file is compatible with non-quoted docker environment (source)

• environmentFileDockerToBashCompatible - Ensure an environment file is compatible with non-quoted docker environment (source)

• environmentFileIsDocker - Ensure an environment file is compatible with non-quoted docker environment (source)

• environmentFileLoad - Safely load an environment file (no code execution) (source)

• environmentFileShow - Display and validate application variables. (source)

• environmentFileToBashCompatible - Takes any environment file and makes it bash-compatible (source)

• environmentFileToDocker - Takes any environment file and makes it docker-compatible (source)

• environmentLines - List lines of environment values set in a bash state (source)

• environmentLoad - Safely load an environment from stdin (no code execution) (source)

• environmentNames - List names of environment values set in a bash state (source)

• environmentOutput - Output all exported environment variables, hiding secure ones and ones (source)

• environmentSecureVariables - List environment variables related to security (source)

• environmentValueConvertArray - Convert an array value which was loaded already (source)

• environmentValueRead - Return Code: 1 - If value is not found and (source)

• environmentValueReadArray - Read an array value from a state file (source)

• environmentValueWrite - Write a value to a state file as NAME="value" (source)

• environmentValueWriteArray - Write an array value as NAME=([0]="a" [1]="b" [2]="c") (source)

• environmentVariableNameValid - Validates zero or more environment variable names. (source)

• environmentVariables - Output a list of environment variables and ignore function definitions (source)

• escapeBash - Converts strings to shell escaped strings (source)

• escapeDoubleQuotes - Quote strings for inclusion in shell quoted strings (source)

• escapeQuotes - Quote strings for inclusion in shell quoted strings (source)

• escapeSingleQuotes - Quote strings for inclusion in shell quoted strings (source)

• evalCheck - Check files to ensure evals in code have been checked (source)

• execute - Run binary and output failed command upon error (source)

• executeEcho - Output the command ... to stdout prior to running, then (source)

• executeInputSupport - Support arguments and stdin as arguments to an executor (source)

• extensionLists - Generates a directory containing files with extension as the file (source)

• fileCopy - Copy file from source to destination (source)

• fileCopyWouldChange - Check whether copying a file would change it (source)

• fileDirectoryExists - Does the file's directory exist? (source)

• fileDirectoryRequire - Given a list of files, ensure their parent directories exist (source)

• fileEndsWithNewline - Does a file end with a newline or is empty? (source)

• fileExtractLines - Extract a range of lines from a file (source)

• fileGroup - Outputs the file group for each file passed on the (source)

• fileIsEmpty - Is this an empty (zero-sized) file? (source)

• fileIsNewest - Check to see if the first file is the newest (source)

• fileIsOldest - Check to see if the first file is the newest (source)

• fileLineCount - Outputs the number of lines read from stdin (or supplied (source)

• fileMatches - Find one or more patterns in a list of files, (source)

• fileModificationSeconds - Fetch the modification time in seconds from now of a (source)

• fileModificationTime - Fetch the modification time of a file as a timestamp (source)

• fileModificationTimes - Lists files in a directory recursively along with their modification (source)

• fileModifiedDays - Prints days (integer) since modified (source)

• fileModifiedRecently - List the most recently modified file in a directory prefixed (source)

• fileModifiedSeconds - Prints seconds since modified (source)

• fileNewest - Return the newest file in the list (source)

• fileNotMatches - Find list of files which do NOT match a specific (source)

• fileOldest - Return the oldest file in the list. (source)

• fileOwner - Outputs the file owner for each file passed on the (source)

• fileReverseLines - Reverse output lines (source)

• fileSize - Outputs value of virtual memory allocated for a process, value (source)

• fileTemporaryName - Wrapper for mktemp. Generate a temporary file name, and fail (source)

• fileType - Better type handling of shell objects (source)

• filesRename - Rename a list of files usually to back them up temporarily (source)

• findUncaughtAssertions - Search bash files for assertions which do not terminate a (source)

• fingerprint - Update file from APPLICATION_JSON with application fingerprint. (source)

• floatRound - Convert float to nearest integer (up or down) (source)

• floatTruncate - Convert float to an integer, round down always (source)

• getFromPipelineYML - DEPRECATED 2025-07-07 (source)

• gitBranchExists - Does a branch exist locally or remotely? (source)

• gitBranchExistsLocal - Does a branch exist locally? (source)

• gitBranchExistsRemote - Does a branch exist remotely? (source)

• gitBranchMergeCurrent - Merge the current branch with another, push to remote, and (source)

• gitBranchify - Check out a branch with the current version and optional (source)

• gitCommit - Commits all files added to git and also update release (source)

• gitCommitHash - Get the commit hash (source)

• gitCurrentBranch - Get the current branch name (source)

• gitEnsureSafeDirectory - When running git operations on a deployment host, at times (source)

• gitFindHome - Finds .git directory above or at startingDirectory (source)

• gitHasAnyRefs - Does git have any tags? (source)

• gitHookTypes - List current valid git hook types (source)

• gitInsideHook - Are we currently inside a git hook? (source)

• gitInstall - Install git if needed (source)

• gitInstallHook - Install the most recent version of this hook and RUN (source)

• gitInstallHooks - Install one or more git hooks from Zesk Build hooks. (source)

• gitMainly - Return Code: 1 - Already in main, staging, or HEAD, (source)

• gitPreCommitCleanup - Clean up after our pre-commit (deletes cache directory) (source)

• gitPreCommitExtensionList - List the extensions available (source)

• gitPreCommitHasExtension - Does this commit have the following file extensions? (source)

• gitPreCommitHeader - Output a display for pre-commit files changed (source)

• gitPreCommitListExtension - List the file(s) of an extension (source)

• gitPreCommitSetup - Set up a pre-commit hook and create a cache of (source)

• gitRemoteHosts - List remote hosts for the current git repository (source)

• gitRemoveFileFromHistory - Has a lot of caveats (source)

• gitRepositoryChanged - Return Code: 1 - the repo has NOT been modified (source)

• gitShowChanges - Return Code: 0 - the repo has been modified (source)

• gitShowStatus - Return Code: 0 - the repo has been modified (source)

• gitTagAgain - Remove a tag everywhere and tag again on the current (source)

• gitTagDelete - Delete git tag locally and at origin (source)

• gitTagVersion - Generates a git tag for a build version, so v1.0d1, (source)

• gitUninstall - Uninstall git (source)

• gitVersionLast - Get the last reported version. (source)

• gitVersionList - Fetches a list of tags from git and filters those (source)

• githubLatest - Get the latest JSON structure (source)

• githubLatestRelease - Get the latest release version (source)

• githubProjectJSON - Get a project JSON structure (source)

• githubPublishDate - Output the publish date for the latest release of ownerRepository (source)

• githubRelease - Generate a release on GitHub using API (source)

• githubURLParse - Parse a GitHub URL and return the owner and project (source)

• grepSafe - grep but returns 0 when nothing matches (source)

• groupID - Convert a group name to a group ID (source)

• hasColors - Sets the environment variable BUILD_COLORS if not set, uses TERM (source)

• hasConsoleAnimation - Does the console support animation? (source)

• hasHook - Determine if a hook exists (source)

• hookRun - Run a project hook (source)

• hookRunOptional - Identical to hookRun but returns exit code zero if the (source)

• hookSource - Run a project hook (source)

• hookSourceOptional - Identical to hookRun but returns exit code zero if the (source)

• hookVersionCurrent - Application current version (source)

• hookVersionLive - Application deployed version (source)

• hostIPList - DEPRECATED 2025-07-07 (source)

• hostTTFB - Fetch Time to First Byte and other stats (source)

• hostnameFull - Get the full hostname (source)

• housekeeper - Run a command and ensure files are not modified (source)

• iTerm2Aliases - Installs iTerm2 aliases which are: (source)

• iTerm2Attention - Attract the operator (source)

• iTerm2Badge - Set the badge for the iTerm2 console (source)

• iTerm2ColorNames - Solely the color names (e.g blue), not anything else (source)

• iTerm2ColorTypes - Colors for various UI elements (source)

• iTerm2Download - Download an file from remote to terminal host (source)

• iTerm2Image - Output an image to the console (source)

• iTerm2Init - Add iTerm2 support to console (source)

• iTerm2IsColorName - Is it a color name? (source)

• iTerm2IsColorType - This is faster than inArray etc. (source)

• iTerm2Notify - Sends a notification message via Mac OS X from iTerm2 (source)

• iTerm2PromptSupport - Add support for iTerm2 to bashPrompt (source)

• iTerm2SetColors - Set terminal colors (source)

• iTerm2Version - Output the iTerm2 version (source)

• identicalCheck - Return Code: 2 - Argument error (source)

• identicalCheckShell - Identical check for shell files (source)

• identicalFindTokens - undocumented (source)

• identicalRepair - Repair an identical token in destination from source (source)

• identicalWatch - Watch a project for changes and propagate them immediately upon (source)

• inArray - Check if an element exists in an array (source)

• incrementor - Set or increment a process-wide incrementor. If no numeric value (source)

• insideDocker - Are we inside a docker container right now? (source)

• installInstallBinary - Installs an installer the first time in a new project, (source)

• installInstallBuild - Installs install-bin-build.sh the first time in a new project, and (source)

• interactiveBashSource - DEPRECATED 2025-07-29 (source)

• interactiveCountdown - Display a message and count down display (source)

• interactiveManager - Run checks interactively until errors are all fixed. (source)

• interactiveOccasionally - Do something the first time and then only occasionally thereafter. (source)

• ipLookup - Get the current IP address of a host (source)

• isAbsolutePath - DEPRECATED 2025-10-03 (source)

• isAlpine - Is this an Alpine system? (source)

• isArray - Is a variable declared as an array? (source)

• isBashBuiltin - Return Code: 0 - Yes, this string is a bash (source)

• isBashDebug - Returns whether the shell has the debugging flag set (source)

• isBitBucketPipeline - Are we currently in the BitBucket pipeline? (source)

• isBoolean - Boolean test (source)

• isCallable - Test if all arguments are callable as a command (source)

• isCharacterClass - Poor-man's bash character class matching (source)

• isCharacterClasses - Does this character match one or more character classes? (source)

• isDarwin - Are we on Mac OS X? (source)

• isDockerComposeCommand - Is this a docker compose command? (source)

• isEmptyFile - DEPRECATED 2025-07-07 (source)

• isErrorExit - Returns whether the shell has the error exit flag set (source)

• isExecutable - Test if all arguments are executable binaries (source)

• isFunction - Test if argument are bash functions (source)

• isInteger - Test if an argument is a signed integer (source)

• isMappable - Check if text contains mappable tokens (source)

• isNewestFile - DEPRECATED 2025-07-07 (source)

• isNumber - Test if an argument is a floating point number (source)

• isOldestFile - DEPRECATED 2025-07-07 (source)

• isPHPStorm - Are we within the JetBrains PHPStorm terminal? (source)

• isPlain - Check if text contains plaintext only. (source)

• isPositiveInteger - Test if an argument is a positive integer (non-zero) (source)

• isPyCharm - Are we within the JetBrains PyCharm terminal? (source)

• isS3URL - Is the URL passed in a S3 URL? (source)

• isSubstring - Check if one string is a substring of another set (source)

• isSubstringInsensitive - Check if one string is a substring of another set (source)

• isTTYAvailable - Quiet test for a TTY (source)

• isTrue - True-ish (source)

• isType - Bash types beyond type -t (source)

• isUnsignedInteger - Test if an argument is an unsigned integer (source)

• isUnsignedNumber - Test if an argument is a positive floating point number (source)

• isUpToDate - Test whether the key needs to be updated (source)

• isValidateType - Are all arguments passed a valid validate type? (source)

• isVersion - Check if something matches a version (source)

• isVisualStudioCode - Are we within the Microsoft Visual Studio Code terminal? (source)

• isiTerm2 - Is the current console iTerm2? (source)

• jsonField - Fetch a non-blank field from a JSON file with error (source)

• jsonFileGet - Get a value in a JSON file (source)

• jsonFileSet - Set or delete a value in a JSON file (source)

• jsonPath - Generate jq paths (source)

• jsonSetValue - Sets the value of a variable in a JSON file (source)

• labeledBigText - Outputs a label before a bigText for output. (source)

• lineFill - Output a line and fill columns with a character (source)

• linkCreate - Create a link (source)

• linkRename - Renames a link forcing replacement, and works on different versions (source)

• listAppend - Add an item to the beginning or end of a (source)

• listCleanDuplicates - Removes duplicates from a list and maintains ordering. (source)

• listJoin - Output arguments joined by a character (source)

• listRemove - Remove one or more items from a text-delimited list (source)

• loadAverage - Get the load average using uptime (source)

• loopExecute - Run checks interactively until errors are all fixed. (source)

• lowercase - Convert text to lowercase (source)

• makeShellFilesExecutable - Makes all *.sh files executable (source)

• manPathCleanDuplicates - Cleans the MANPATH and removes non-directory entries and duplicates (source)

• manPathConfigure - Modify the MANPATH environment variable to add a path. (source)

• manPathRemove - Remove a path from the MANPATH environment variable (source)

• mapEnvironment - Convert tokens in files to environment variable values (source)

• mapReturn - map a return value from one value to another (source)

• mapTokens - Short description: list mappable variables in a file (without prefix (source)

• mapValue - Maps a string using an environment file (source)

• mapValueTrim - Maps a string using an environment file (source)

• mariadbConnect - Connect to a mariadb-type database using a URL (source)

• mariadbDump - Dump a MariaDB database to raw SQL (source)

• mariadbDumpClean - Clean mariadb dumps for import (source)

• mariadbInstall - Install mariadb (source)

• mariadbUninstall - Uninstall mariadb (source)

• markdownCheckIndex - Displays any markdown files next to the given index file (source)

• markdownFormatList - Simple function to make list-like things more list-like in Markdown (source)

• markdownIndentHeading - Add an indent to all markdown headings (source)

• markdownRemoveUnfinishedSections - Given a file containing Markdown, remove header and any section (source)

• markdownToConsole - Converts backticks, bold and italic to console colors. (source)

• maximumFieldLength - Given an input file, determine the maximum length of fieldIndex, (source)

• maximumLineLength - Outputs the maximum line length passed into stdin (source)

• modificationSeconds - DEPRECATED 2025-07-07 (source)

• modificationTime - DEPRECATED 2025-07-07 (source)

• modifiedDays - DEPRECATED 2025-07-07 (source)

• modifiedSeconds - DEPRECATED 2025-07-07 (source)

• muzzle - Suppress stdout without piping. Handy when you just want a (source)

• networkIPList - List IPv4 Addresses associated with this system using ifconfig (source)

• networkMACAddressList - List MAC addresses associated with this system using ifconfig (source)

• newRelease - DEPRECATED 2025-10-03 (source)

• newestFile - DEPRECATED 2025-07-07 (source)

• newlineHide - Hide newlines in text (to ensure single-line output or other (source)

• nodeInstall - Install nodejs (source)

• nodePackageManager - Run an action using the current node package manager (source)

• nodePackageManagerInstall - Installs the selected package manager for node (source)

• nodePackageManagerUninstall - Installs the selected package manager for node (source)

• nodePackageManagerValid - Is the passed node package manager name valid? (source)

• nodeUninstall - Uninstall nodejs (source)

• notify - Notify after running a binary. Uses the notify hook with (source)

• npmInstall - Install NPM in the build environment (source)

• npmUninstall - Core as part of some systems - so this succeeds (source)

• oldestFile - DEPRECATED 2025-07-07 (source)

• outputTrigger - Check output for content and trigger environment error if found (source)

• packageAvailableList - List installed packages on this system using package manager (source)

• packageDefault - Fetch the binary name for the default package in a (source)

• packageGroupInstall - Install a package group (source)

• packageGroupUninstall - Uninstall a package group (source)

• packageGroupWhich - Install a package group to have a binary installed (source)

• packageInstall - Install packages using a package manager (source)

• packageInstalledList - List installed packages on this system using package manager (source)

• packageIsInstalled - Is a package installed? (source)

• packageManagerDefault - Determine the default package manager on this platform. (source)

• packageManagerValid - Is the package manager supported? (source)

• packageMapping - undocumented (source)

• packageNeedRestartFlag - INTERNAL - has packageUpdate set the restart flag at some (source)

• packageUninstall - Removes packages using package manager (source)

• packageUpdate - Update packages lists and sources (source)

• packageUpgrade - Upgrade packages lists and sources (source)

• packageWhich - Install tools using apt-get if they are not found (source)

• packageWhichUninstall - Install tools using apt-get if they are not found (source)

• parseBoolean - Parses text and determines if it's true-ish (source)

• pathCleanDuplicates - Cleans the path and removes non-directory entries and duplicates (source)

• pathConfigure - Modify the PATH environment variable to add a path. (source)

• pathIsAbsolute - Is a path an absolute path? (source)

• pathRemove - Remove a path from the PATH environment variable (source)

• pathShow - Show the path and where binaries are found (source)

• pause - Pause for user input (source)

• pcregrepBinary - The name of the pcregrep binary on this operating system (source)

• pcregrepInstall - Install pcregrep binary (source)

• phpBuild - Build deployment using composer, adding environment values to .env and (source)

• phpComposer - Run Composer commands on code (source)

• phpComposerInstall - Install composer for PHP (source)

• phpComposerSetVersion - For any project, ensures the version field in composer.json matches (source)

• phpIniFile - Outputs the path to the PHP ini file (source)

• phpInstall - Install php (source)

• phpLog - Outputs the path to the PHP log file (source)

• phpTailLog - Tail the PHP log (source)

• phpTest - Test a docker-based PHP application during build (source)

• phpUninstall - Uninstall php (source)

• pipInstall - Utility to install python dependencies via pip (source)

• pipUninstall - Utility to uninstall python dependencies via pip (source)

• pipUpgrade - Utility to upgrade pip correctly (source)

• pipWrapper - Run pip whether it is installed as a module or (source)

• pipeRunner - Single reader, multiple writers (source)

• plainLength - Length of an unformatted string (source)

• plasterLines - Outputs a line and fills the remainder with space (source)

• plumber - Run command and detect any global or local leaks (source)

• plural - Outputs the singular value to standard out when the value (source)

• pluralWord - Plural word which includes the numeric prefix and the noun. (source)

• printfOutputPrefix - Pipe to output some text before any output, otherwise, nothing (source)

• printfOutputSuffix - Pipe to output some text after any output, otherwise, nothing (source)

• processMemoryUsage - Outputs value of resident memory used by a process, value (source)

• processOpenPipes - Output the number of open files for a process ID (source)

• processVirtualMemoryAllocation - Outputs value of virtual memory allocated for a process, value (source)

• processWait - Wait for processes not owned by this process to exit, (source)

• pythonInstall - Install python (source)

• pythonPackageInstalled - Is a package installed for python? (source)

• pythonUninstall - Uninstall python (source)

• pythonVirtual - Set up a virtual environment for a project and install (source)

• quoteBashString - Quote bash strings for inclusion as single-quoted for eval (source)

• quoteGrepPattern - Quote grep -e patterns for shell use (source)

• quoteSedPattern - Quote sed search strings for shell use (source)

• quoteSedReplacement - Quote sed replacement strings for shell use (source)

• randomString - Outputs 40 random hexadecimal characters, lowercase. (source)

• readlineConfigurationAdd - Add configuration to ~/.inputrc for a key binding (source)

• realPath - Find the full, actual path of a file avoiding symlinks (source)

• releaseNew - Generate a new release notes and bump the version (source)

• releaseNotes - Output path to current release notes (source)

• reloadChanges - Watch or more directories for changes in a file extension (source)

• removeFields - Remove fields from left to right from a text file (source)

• renameFiles - DEPRECATED 2025-07-07 (source)

• renameLink - DEPRECATED 2025-07-07 (source)

• repeat - Repeat a string (source)

• replaceFirstPattern - Replaces the first and only the first occurrence of a (source)

• requireDirectory - DEPRECATED 2025-07-07 (source)

• requireFileDirectory - DEPRECATED 2025-07-07 (source)

• returnArgument - Return argument error code. Outputs message ... to stderr. (source)

• returnClean - Delete files or directories and return the same exit code (source)

• returnCode - Print one or more return codes by name. (source)

• returnCodeString - Output the exit code as a string (source)

• returnEnvironment - Return environment error code. Outputs message ... to stderr. (source)

• returnMessage - Return passed in integer return code and output message to (source)

• returnThrow - Run handler with a passed return code (source)

• returnUndo - Run a function and preserve exit code (source)

• reverseFileLines - DEPRECATED 2025-07-07 (source)

• rotateLog - Rotate a log file (source)

• rotateLogs - Rotate log files (source)

• roundFloat - DEPRECATED 2025-07-07 (source)

• rsyncInstall - Install rsync. (source)

• runCount - Run a binary count times (source)

• sedReplacePattern - Quote a sed command for search and replace (source)

• semanticColorTest - DEPRECATED 2025-07-16 (source)

• serviceToPort - Get the port number associated with a service (source)

• serviceToStandardPort - Hard-coded services for: (source)

• shaPipe - SHA1 checksum of standard input (source)

• simplifyPath - DEPRECATED 2025-07-07 (source)

• singleBlankLines - Ensures blank lines are singular (source)

• sshKnownHostAdd - Adds the host to the ~/.known_hosts if it is not (source)

• sshKnownHostRemove - Adds the host to the ~/.known_hosts if it is not (source)

• sshKnownHostsFile - #!/usr/bin/env bash (source)

• sshSetup - Set up SSH for a user with ID and backup (source)

• statusMessage - Output a status message and display correctly on consoles with animation and in log files (source)

• stringBegins - Find whether a substring exists as teh beginning of one or more strings (source)

• stringBeginsInsensitive - Find whether a substring exists as teh beginning of one or more strings (source)

• stringContains - Find whether a substring exists in one or more strings (source)

• stringContainsInsensitive - Find whether a substring exists in one or more strings (source)

• stringOffset - Outputs the integer offset of needle if found as substring (source)

• stringOffsetInsensitive - Outputs the integer offset of needle if found as substring (source)

• stringReplace - Replace all occurrences of a string within another string (source)

• stringValidate - Ensure that every character in a text string passes all (source)

• stripAnsi - Strip ANSI console escape sequences from a file (source)

• sysvInitScriptInstall - Install a script to run upon initialization. (source)

• sysvInitScriptUninstall - Remove an initialization script (source)

• tarCreate - Platform agnostic tar cfz which ignores owner and attributes (source)

• tarExtractPattern - Platform agnostic tar extract with wildcards (source)

• terraformInstall - Install terraform binary (source)

• terraformUninstall - Remove terraform binary (source)

• testTools - Load test tools and make testSuite function available (source)

• throwArgument - Run handler with an argument error (source)

• throwEnvironment - Run handler with an environment error (source)

• timestampToDate - DEPRECATED 2025-07-07 (source)

• timing - Time command, similar to time but uses internal functions (source)

• timingFormat - Format a timing output (milliseconds) as seconds using a decimal (source)

• timingReport - Output the time elapsed (source)

• timingStart - Start a timer (source)

• todayDate - Today's date in UTC (source)

• tofuInstall - Install tofu binary (source)

• tofuUninstall - Uninstall tofu binary and apt sources keys (source)

• tomorrowDate - Tomorrow's date in UTC (source)

• tools - Run a Zesk Build command or load it (source)

• trimBoth - Trim whitespace from beginning and end of a stream (source)

• trimHead - Removes any blank lines from the beginning of a stream (source)

• trimSpace - Trim whitespace of a bash argument (source)

• trimTail - Removes any blank lines from the end of a stream (source)

• trimWords - Remove words from the end of a phrase (source)

• truncateFloat - DEPRECATED 2025-07-07 (source)

• unquote - Unquote a string (source)

• uppercase - Convert text to uppercase (source)

• urlContentLength - Get the size of a remote URL (source)

• urlFetch - Fetch URL content (source)

• urlFilter - Open URLs which appear in a stream (source)

• urlMatchesLocalFileSize - Compare a remote file size with a local file size (source)

• urlOpen - Open a URL using the operating system (source)

• urlOpener - Open URLs which appear in a stream (source)

• urlParse - Simple URL Parsing (source)

• urlParseItem - Get a URL component directly (source)

• urlSchemeDefaultPort - Output the port for the given scheme (source)

• urlValid - Checks if a URL is valid (source)

• usageArgumentApplicationDirectory - Validates a value as an application-relative directory. Upon success, outputs (source)

• usageArgumentApplicationDirectoryList - Validates a value as an application-relative directory search list. Upon (source)

• usageArgumentApplicationFile - Validates a value as an application-relative file. Upon success, outputs (source)

• usageArgumentArguments - Placeholder for additional arguments (source)

• usageArgumentArray - Placeholder for array types (source)

• usageArgumentBoolean - Require an argument to be a boolean value (source)

• usageArgumentCallable - Require an argument to be a callable (source)

• usageArgumentColonDelimitedList - List delimited with colons : (source)

• usageArgumentCommaDelimitedList - List delimited with commas , (source)

• usageArgumentDate - A remote path is one which exists in another file (source)

• usageArgumentDirectory - Validates a value is not blank and is a directory. (source)

• usageArgumentDirectoryList - Validates a value as a directory search list. Upon success, (source)

• usageArgumentEmptyString - Do not require argument to be non-blank (source)

• usageArgumentEnvironmentVariable - Validates a value is ok for an environment variable name (source)

• usageArgumentExecutable - Require an argument to be a executable (source)

• usageArgumentExists - Validates a value is not blank and exists in the (source)

• usageArgumentFile - Validates a value is not blank and is a file. (source)

• usageArgumentFileDirectory - Validates a value is not blank and is a file (source)

• usageArgumentFlag - List delimited with colons : (source)

• usageArgumentFunction - Require an argument to be a function (source)

• usageArgumentInteger - Validates a value is an integer (source)

• usageArgumentLink - Validates a value is not blank and is a link (source)

• usageArgumentList - List delimited with spaces (source)

• usageArgumentLoadEnvironmentFile - Validates a value is not blank and is an environment (source)

• usageArgumentNumber - Validates a value is a number (source)

• usageArgumentPositiveInteger - Validates a value is an positive integer and greater than (source)

• usageArgumentRealDirectory - Validates a value is not blank and is a directory (source)

• usageArgumentRealFile - Validates a value is not blank and is a file (source)

• usageArgumentRemoteDirectory - A remote path is one which exists in another file (source)

• usageArgumentSecret - Secrets are things which should be kept secret (source)

• usageArgumentString - Require an argument to be non-blank (source)

• usageArgumentURL - Require an argument to be a URL (source)

• usageArgumentUnsignedInteger - Validates a value is an unsigned integer and greater than (source)

• usageDocument - Universal error handler for functions (with formatting) (source)

• usageDocumentSimple - Output a simple error message for a function (source)

• usageRequireBinary - Check that one or more binaries are installed (source)

• usageRequireEnvironment - Requires environment variables to be set and non-blank (source)

• userHome - The current user HOME (must exist) (source)

• userRecord - Quick user database look up (source)

• userRecordHome - Quick user database query of the user home directory (source)

• userRecordName - Quick user database query of the user name (source)

• validate - Validate a value by type (source)

• validateFileContents - Check files for the existence of a string or strings (source)

• validateFileExtensionContents - Check files for the existence of a string (source)

• validateTypeList - List types which can be validated (source)

• veeGitTag - Given a tag in the form "1.1.3" convert it to (source)

• versionNextMinor - Converts vX.Y.N to vX.Y.(N+1) so v1.0.0 to v1.0.1 (source)

• versionNoVee - Take one or more versions and strip the leading v (source)

• versionSort - Sort versions in the format v0.0.0 (source)

• watchDirectory - Watch a directory (source)

• websiteScrape - Scrape a website. (source)

• whichExists - Does a binary exist in the PATH? (source)

• whichHook - Find the path to a hook binary file (source)

• xdebugDisable - Disable Xdebug on systems that have it (source)

• xdebugEnable - Enable Xdebug on systems that have it (source)

• xdebugInstall - Install the xdebug PHP Debugger (source)

• yarnInstall - Install yarn in the build environment (source)

• yesterdayDate - Yesterday's date (UTC time) (source)

• yumIsInstalled - Is yum installed? (source)