Function Index

All functions in Zesk Build, alphabetically.

🛠️ Indexes · ⬅ Home

alpineContainer - Open an Alpine container shell (source)
apkIsInstalled - Is this an Alpine system and is apk installed? (source)
applicationHome - Set, or cd to current application home directory. (source)
applicationHomeAliases - `applicationHome` bash aliases setup (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 - Remove keys to disable apt to download tofu from opentofu.org (source)
aptKeyRingDirectory - Get key ring directory path (source)
aptNonInteractive - Run apt-get non-interactively (source)
aptSourcesDirectory - Get APT source list path (source)
assertContains - Assert one string contains another (case-sensitive) (source)
assertDirectoryDoesNotExist - Test that a directory does not exist (source)
assertDirectoryEmpty - Test that a directory exists (source)
assertDirectoryExists - Test that a directory exists (source)
assertDirectoryNotEmpty - Test that a directory does not exist (source)
assertEquals - Assert two strings are equal. (source)
assertExitCode - Assert a process runs and exits with the correct exit (source)
assertFileContains - Assert a file contains one or more strings (source)
assertFileDoesNotContain - Assert a file does not contains any occurrence of one (source)
assertFileDoesNotExist - Test that a file does not exist (source)
assertFileExists - Test that a file exists (source)
assertFileSize - Assert a file has an expected size in bytes (source)
assertGreaterThan - Assert `leftValue > rightValue` (source)
assertGreaterThanOrEqual - Assert actual value is greater than or equal to expected value (source)
assertLessThan - Assert `leftValue < rightValue` (source)
assertLessThanOrEqual - Assert `leftValue <= rightValue` (source)
assertNotContains - Assert one string does not contains another (case-sensitive) (source)
assertNotEquals - Assert two strings are not equal (source)
assertNotExitCode - Assert a process runs and exits with an exit code (source)
assertNotFileSize - Assert a file does NOT have an expected size in (source)
assertNotZeroFileSize - Assert a file is non-empty (non-zero sized) (source)
assertOutputContains - Run a command and expect the output to contain the (source)
assertOutputDoesNotContain - Run a command and expect the output to not contain (source)
assertOutputEquals - Assert output of a binary equals a string (source)
assertStatistics - Output assertion counts (source)
assertStringEmpty - Assert a string is empty. (source)
assertStringNotEmpty - Assert a string is non-empty. (source)
assertZeroFileSize - Assert a file is empty (zero sized) (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)
bashApplicationAlias - Create alias for project (source)
bashApplicationAliases - Create aliases for projects (source)
bashBuiltins - List bash builtin 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)
bashCommentVariable - Gets a list of the variable values from a bash (source)
bashCoverage - Collect code coverage statistics for a code sample (source)
bashCoverageEnabled - Is bash coverage currently running? (source)
bashCoverageReport - Experimental. Likely abandon. (source)
bashDebug - Bash debugger (source)
bashDebugInterruptFile - Output debugging stack on program termination (source)
bashDebuggerDisable - Disable the debugger (source)
bashDebuggerEnable - Enable the debugger (source)
bashDocumentation - Universal function documentation (source)
bashDocumentationAllEnvironment - Generate markdown for a list of all functions (source)
bashDocumentationAllFunctions - Generate markdown for a list of all functions (source)
bashDocumentationDefaults - Generate base template files for Bash code documentation. (source)
bashDocumentationDeriveFunction - Generate markdown documentation page (source)
bashDocumentationDeriveSee - Generate SEE markdown content (source)
bashDocumentationExtract - $'Extract documentation from bash commentsGenerate a set of name/value pairs to document bash entities\n' (source)
bashDocumentationMarkdown - Output documentation for a function in Markdown format (source)
bashDocumentationMissing - Generate templates of functions missing from documentation (source)
bashFileComment - Extract a bash comment from a file. Excludes lines containing (source)
bashFinalComment - Extract final comment from a stream (source)
bashFindUncaughtAssertions - Search bash files for assertions which do not terminate a (source)
bashFirstComment - Extract first comment from a stream (source)
bashFunctionComment - Output the comment for a function in a file (source)
bashFunctionCommentVariable - Gets a list of the variable values from a bash (source)
bashFunctionDefined - Is a function defined in a bash source file? (source)
bashFunctionNameValid - Is a string a valid function name? (source)
bashGetRequires - Fetch requirements lines from a bash file (source)
bashLibrary - Run or source a library (source)
bashLibraryHome - Output the home for a library in the parent path (source)
bashLint - Check bash files for common errors (source)
bashLintFiles - Lint multiple bash files (source)
bashLintFilesInteractive - Run checks interactively until errors are all fixed. (source)
bashListFunctions - List functions in a bash file (source)
bashMakeExecutable - Make shell files executable (source)
bashPrompt - Bash prompt toolkit (source)
bashPromptColorScheme - Color scheme values for prompts (source)
bashPromptColorsFormat - Convert colors to escape codes (source)
bashPromptMarkers - Set markers for terminal integration (source)
bashPromptModule_TermColors - Terminal colors to match projects (source)
bashPromptModule_dotFilesWatcher - Monitor home directory for new `.` files (source)
bashRecursionDebug - Recursion detection (source)
bashRemoveCommentCharacter - Remove comment character (source)
bashSanitize - Sanitize bash files for code quality. (source)
bashShowUsage - Show function handler in files (source)
bashSimpleDocumentation - Simpler `bashDocumentation` (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)
bitbucketContainer - Run the default build container for build testing on BitBucket (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)
booleanParse - Parses text and determines if it's true-ish (source)
brewInstall - Install Homebrew (source)
buildApplicationConfigure - Configure project for Zesk Build (source)
buildCacheDirectory - Path to cache directory for build system. (source)
buildCompletion - Completion for Zesk Build (EXPERIMENTAL) (source)
buildDebugEnabled - Is build debugging enabled? (source)
buildDebugStart - Start bash debugging (source)
buildDebugStop - Stop bash debugging (source)
buildDeprecatedFunctions - List all functions which are currently deprecated in Zesk Build (source)
buildDevelopmentLink - Add a development link to the local version of Zesk (source)
buildEnvironmentAdd - Adds an environment variable file to a project (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)
buildEnvironmentNames - List known environment names (source)
buildFunctions - Prints the list of functions defined in Zesk Build (source)
buildFunctionsExclude - Exclude all function names in this library (source)
buildHome - Prints the build home directory (usually same as the application (source)
buildInternalFunctions - Prints the list of internal functions defined in Zesk Build (source)
buildQuietLog - Generate the path for a quiet log in the build (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 classes allowed in `isCharacterClass` (source)
characterFromInteger - Given a list of integers, output the character codes associated (source)
characterIsClass - Check a character matches any character class (source)
characterToInteger - Convert a character to the corresponding ASCII code (source)
colorBrightness - Return an integer between 0 and 100 (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)
confirmMenu - Ask the user for a menu of options (source)
confirmYesNo - Read user input and return success on yes (source)
consoleBrightness - Output the brightness of the background color of the console as a number between 0 and 100 (source)
consoleColumns - Column count in current console (source)
consoleConfigureColorMode - Print the suggested color mode for the current environment (source)
consoleConfigureDecorate - Modify the decoration environment for light or dark. (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)
consoleHasAnimation - Does the console support animation? (source)
consoleHasColors - Sets the environment variable `BUILD_COLORS` if not set, uses `TERM` (source)
consoleHeadingLine - Output a line and fill columns with a character (source)
consoleLine - Output a bar as wide as the console (source)
consoleLineFill - Clear a line in the console (source)
consoleLink - console hyperlinks (source)
consoleLinksSupported - Are console links (likely) supported? (source)
consolePlainLength - Length of an unformatted string (source)
consoleRows - Row count in current console (source)
consoleSetTitle - Set the title of the window for the console (source)
consoleToPlain - Strip ANSI console escape sequences from a file (source)
consoleTrimWidth - Truncate console output width (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)
cpuCount - Return integer count of CPUs on this system (source)
cpuLoadAverage - Get the load average using uptime (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)
dateToday - Today's date in UTC (source)
dateTomorrow - Tomorrow's date in UTC (source)
dateValid - Is a date valid? (source)
dateWithinDays - Is a date in the past beyond its expiration date? (source)
dateYesterday - Yesterday's date (UTC time) (source)
debuggingStack - Dump the function and include stacks and the current environment (source)
decorate - decorate text using colors and styles (source)
decorateInitialized - Is the decorate color system initialized yet? (source)
decoratePath - Display file paths and replace prefixes with icons (source)
decorateStyle - Get or modify a decoration style (source)
decorateThemed - Applies the current theme to text rendered using `decorateThemelessMode` (source)
decorateThemelessMode - Converts decoration style to a mode where the theme can (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 one or more hosts (source)
deprecatedCannon - undocumented (source)
deprecatedCannonFile - Run textCannon 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 (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)
directoryWatch - Watch a directory (source)
dockerCompose - docker compose wrapper with automatic .env support (source)
dockerComposeCommandIsValid - Validate docker compose subcommands (source)
dockerComposeCommandList - List of docker compose commands (source)
dockerComposeInstall - Install `docker-compose` (source)
dockerComposeIsRunning - Is docker compose currently running? (source)
dockerComposeUninstall - Uninstall `docker-compose` (source)
dockerComposeWrapper - Wrapper for `docker-compose` or `docker compose` (source)
dockerImages - List docker images which are currently pulled (source)
dockerInside - Are we inside a docker container? (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)
documentationCache - Get the default cache directory for the documentation (source)
documentationEnvironmentFileParse - Convert an environment comment to environment variables (source)
documentationEnvironmentMake - Build documentation files for environment variables (source)
documentationFileCompile - Extract and build the documentation settings cache (source)
documentationFilesAdd - Git add documentation files (source)
documentationFunctionCompile - Build function documentation (source)
documentationFunctionRemove - Remove a function from the documentation cache (source)
documentationFunctionsCompile - Extract and build the documentation settings cache and generate derived (source)
documentationFunctionsListSeeUnfinished - List files with unresolved `SEE:` tokens in documentation path (source)
documentationFunctionsSeeDirty - Dirty documentation files with unresolved `SEE:` tokens in documentation path (source)
documentationFunctionsSeeLoop - Interactively watch count of unresolved `SEE:` tokens in documentation (source)
documentationIdenticalRepair - Map template files using our identical functionality (source)
documentationIndexDocumentation - Generate the documentation index (source)
documentationIndexGenerate - Generate a function index for bash files. (source)
documentationIndexLookup - Looks up information in the function index (source)
documentationIndexUnlinkedFunctions - List functions without documentation pages. (source)
documentationMake - Make documentation for Bash functions (source)
documentationMaker - Generate documentation using source markdown and a mapping function. (source)
documentationMkdocs - mkdocs Utility (source)
documentationTemplate - Get an internal template name (source)
documentationTemplateCompile - Document an item and generate a template (markdown). To custom (source)
documentationTemplateFunctionCompile - Generate a function documentation block using `functionTemplate` for `functionName` (source)
documentationUnlinked - List unlinked functions in documentation index (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)
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)
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 - Compile an environment file to evaluated names and values (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)
environmentParseVariables - Parse variables from an environment variable stream (source)
environmentRequire - Requires environment variables to be set and non-blank (source)
environmentSecureVariables - List environment variables related to security (source)
environmentValueConvertArray - Convert an array value which was loaded already (source)
environmentValueRead - undocumented (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 - Bash-string escape (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 `eval`s in code have been checked (source)
executableExists - Does a binary exist in the PATH? (source)
executableRequire - Check that one or more binaries are installed (source)
execute - Run binary and output failed command upon error (source)
executeCount - Run a binary count times (source)
executeEcho - Output the `command ...` to stdout prior to running, then (source)
executeInputSupport - Support arguments and stdin as arguments to an executor (source)
executeLoop - Run checks interactively until errors are all fixed. (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)
fileExtensionLists - Generates a directory containing files with `extension` as the file (source)
fileExtractLines - Extract a range of lines from a file (source)
fileFieldMaximum - Given an input file, determine the maximum length of fieldIndex, (source)
fileGroup - Get the file group name (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)
fileLineMaximum - Outputs the maximum line length passed into stdin (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)
fileModificationTimesAfter - List files modified after a specific timestamp (inclusive) (source)
fileModificationTimesBefore - List files modified before a specific timestamp (inclusive) (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 - Output the newest file in the list (source)
fileNotMatches - Find list of files which do NOT match a specific (source)
fileOldest - Output the oldest file in the list. (source)
fileOwner - Get the file owner name (source)
fileRealPath - Find the full, actual path of a file avoiding symlinks (source)
fileReverseLines - Reverse output lines (source)
fileSize - undocumented (source)
fileTeeAtomic - tee but atomic (EXPERIMENTAL) (source)
fileTemporaryName - Wrapper for `mktemp`. Generate a temporary file name, and fail (source)
fileType - Better type handling of shell objects (source)
fileUniqueLines - Sorts and makes all file lines unique (source)
filesAreIdentical - Are files identical? (source)
filesOpenStatus - Output current open files (source)
filesRename - Rename a list of files usually to back them up temporarily (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)
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 - Find `git` home directory (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 - Merge `staging` and `main` branches of a git repository into (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 - Has a git repository been changed from HEAD? (source)
gitShowChanges - Show changed files from HEAD (source)
gitShowStatus - Show changed files from HEAD with their status prefix character: (source)
gitTagAgain - Remove a tag everywhere and tag again on the current (source)
gitTagDelete - Delete git tag locally and at origin (source)
gitTagVee - Given a tag in the form \"1.1.3\" convert it to (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)
githubVersionLive - Fetch the current live version of software using GitHub APIs (source)
grepSafe - `grep` but returns 0 when nothing matches (source)
groupID - Convert a group name to a group ID (source)
helpArgument - Simple help argument handler. (source)
hookEnvironment - Load hook-related environment variables (source)
hookExists - Determine if a hook exists (source)
hookFind - Find the path to a hook binary file (source)
hookNotify - Send a notification (source)
hookRun - Run a project hook (source)
hookRunOptional - Optionally run a project hook (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)
hostTTFB - Fetch Time to First Byte and other stats (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 Badge Message (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 - When, for whatever reason, you need code to match between (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 incrementor state based on a state (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)
integerClamp - Clamp digits between two integers (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)
isAlpine - Is this an Alpine system? (source)
isArray - Is a variable declared as an array? (source)
isBashBuiltin - Is a token a bash builtin? (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)
isDarwin - Are we on Mac OS X? (source)
isErrorExit - Returns whether the shell has the error exit flag set (source)
isExecutable - Test if all arguments are executable binaries (source)
isFunction - Is argument a bash function? (source)
isInteger - Test if an argument is a signed integer (source)
isMappable - Check if text contains mappable tokens (source)
isNumber - Test if an argument is a floating point number (source)
isPHPStorm - Are we within the JetBrains PHPStorm terminal? (source)
isPlain - Check if text contains plain text only (no ANSI escape (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)
isTTYAvailable - Quiet test for a TTY (source)
isTrue - True-ish (source)
isType - Bash types beyond `type -t` (source)
isUnsignedInteger - Is value an unsigned integer? (source)
isUnsignedNumber - Test if an argument is a positive floating point number (source)
isValidateType - Are validate type names valid? (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)
json - JSON pretty (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)
junitClose - Close tag for `testsuites` (source)
junitOpen - Open tag for `testsuites` (source)
junitProperties - Full properties output. Properties are output depending on content containing (source)
junitPropertyList - Output list of `property` tags (source)
junitSuiteClose - Close tag for `testsuite` (source)
junitSuiteOpen - Open tag for `testsuite` (source)
junitSystemErrorClose - Close tag for `system-err` - test errors (source)
junitSystemErrorOpen - Open tag for `system-err` - test errors (source)
junitSystemOutputClose - Close tag for `system-out` - test output (source)
junitSystemOutputOpen - Open tag for `system-out` - test output (source)
junitTestCaseClose - Close tag for `testcase` - Test case (source)
junitTestCaseErrorClose - Close tag for `error` - test error output (source)
junitTestCaseErrorOpen - Open tag for `error` - test error output (source)
junitTestCaseFailureClose - Close tag for `failure` - test failed (source)
junitTestCaseFailureOpen - Open tag for `failure` - test failed (source)
junitTestCaseOpen - Open tag for `testcase` - Test case (source)
junitTestCaseSkipped - Output test skipped XML (source)
labeledBigText - Outputs a label before a decorate big for output. (source)
linkCreate - Create a link (source)
linkRename - Rename a link (source)
listAppend - Add an item to a character-delimited list. (source)
listCleanDuplicates - Removes duplicates from a list and maintains ordering. (source)
listContains - Does a character-delimited list contain item(s)? (source)
listJoin - Output a list of items joined by a character (source)
listRemove - Remove one or more items from a text-delimited list (source)
localePlural - Outputs the `singular` value to standard out when the value (source)
localePluralWord - Plural word which includes the numeric prefix and the noun. (source)
logDirectoryRotate - Rotate log files (source)
logRotate - Rotate a log file (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)
mapEnvironmentFun - Convert tokens in files to environment variable values (source)
mapEnvironmentSed - Convert tokens in files to environment variable values (source)
mapFunction - Convert tokens in input to values (source)
mapTokens - undocumented (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)
markdownHeadingsToConsole - Convert Markdown Heading lines to console (source)
markdownIndentHeading - Add an indent to all markdown headings (source)
markdownRemoveUnfinishedSections - Remove markdown sections with tokens (source)
markdownToConsole - Converts backticks, bold and italic to console colors. (source)
mockConsoleAnimationStart - Fake `consoleHasAnimation` for testing (source)
mockConsoleAnimationStop - Stop faking `consoleHasAnimation` for testing (source)
mockEnvironmentStart - Fake a value for testing (source)
mockEnvironmentStop - Restore a mocked value. Works solely with the default `saveGlobalName` (source)
muzzle - Suppress stdout without piping. Handy when you just want a (source)
muzzleReturn - Suppress return codes (source)
networkIPList - List IPv4 Addresses associated with this system using `ifconfig` (source)
networkIPLookup - Get the current IP address of a host (source)
networkIPValid - Is a network IP valid? (source)
networkMACAddressList - List MAC addresses associated with this system using `ifconfig` (source)
networkNameFull - Platform-agnostic host name (source)
networkNameValid - Is a network host name valid? (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)
notifyURL - Send a notification by submitting data to a URL (source)
npmInstall - Install NPM in the build environment (source)
npmUninstall - Core as part of some systems - so this succeeds (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)
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)
plasterLines - Outputs a line and fills the remainder with space (source)
plumber - Run command and detect any global or local leaks (source)
printfOutputEmpty - printf when output is blank (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)
processCountWatcher - Watch the number of processes matching `token` and fail if (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)
readlineConfigurationAdd - Add configuration to `~/.inputrc` for a key binding (source)
releaseNew - Generate a new release notes and bump the version (source)
releaseNotes - Output path to current release notes (source)
releaseNotesMarkdown - Generate markdown for release notes (source)
reloadChanges - Watch or more directories for changes in a file extension (source)
returnArgument - Return `argument` error code. Outputs `message ...` to `stderr`. (source)
returnAssert - Assertion return code (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)
returnExit - Exit return code (source)
returnIdentical - Identical return code (source)
returnLeak - Leak return code (source)
returnMap - map a return value from one value to another (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)
rsyncInstall - Install `rsync`. (source)
sedReplacePattern - Quote a sed command for search and replace (source)
serviceToPort - Get the port number associated with a service (source)
serviceToStandardPort - Handle standard services (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 - undocumented (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)
stringFound - Check if one string is a substring of another set (source)
stringFoundInsensitive - Check if one string is a substring of another set (source)
stringHideNewlines - Replace newlines in text with a replacement token for single-line output (source)
stringLowercase - Convert text to stringLowercase (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)
stringRandom - Outputs 40 random hexadecimal characters, stringLowercase. (source)
stringTrimWords - Remove words from the end of a phrase (source)
stringUnquote - Unquote a string (source)
stringUppercase - Convert text to uppercase (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)
testSuite - Run bash test suites for {name}. (source)
testSuiteFunctionTested - When environment variable `TEST_TRACK_ASSERTIONS` is `true` – `testSuite` and assertion (source)
testSuiteOrdering - undocumented (source)
textAlignLeft - align text left (source)
textAlignRight - align text right (source)
textCannon - Replace text `fromText` with `toText` in files (source)
textRemoveFields - Remove fields from left to right from a text file (source)
textRepeat - Repeat a string (source)
textReplace - Replace all occurrences of a string within another string (source)
textReplaceFirst - Replaces the first and only the first occurrence of a (source)
textSHA - SHA1 checksum of standard input (source)
textSingleBlankLines - Ensures blank lines are singular (source)
textTrim - Trim whitespace of a bash argument (source)
textTrimBoth - Trim whitespace from beginning and end of a stream (source)
textTrimHead - Removes any blank lines from the beginning of a stream (source)
textTrimLeft - Trim whitespace of a bash argument (source)
textTrimRight - Trim whitespace of a bash argument (source)
textTrimTail - Removes any blank lines from the end of a stream (source)
textVersionSort - Sort versions in the format v0.0.0 (source)
throwArgument - Run `handler` with an argument error (source)
throwEnvironment - Run `handler` with an environment error (source)
timing - Time command, similar to `time` but uses internal functions (source)
timingDuration - Output timing like \"1 day, 2 hours, 3 minutes, 4 (source)
timingElapsed - Show elapsed time from a start time (source)
timingFormat - Format a timing output (milliseconds) as seconds using a decimal (source)
timingReport - Output the time elapsed (source)
timingStart - Start a timer (source)
tofuInstall - Install tofu binary (source)
tofuUninstall - Uninstall tofu binary and apt sources keys (source)
tools - Run a Zesk Build command or load it (source)
urlContentLength - Get the size of a remote URL (source)
urlFetch - Fetch URL content (source)
urlFilter - Extract URLs from arbitrary text content (source)
urlMatchesLocalFileSize - Compare a remote file size with a local file size (source)
urlOpen - Opens the default browser for a URL on the host operating system (source)
urlOpener - URL opener stream filter (source)
urlParse - Simple URL Parsing (source)
urlParseItem - Get a URL component directly (source)
urlSchemeDefaultPort - Output the port for the given scheme (source)
urlValid - Is a URL valid? (source)
userAgentDefault - Default user agent string for web agents (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)
validateTypeList - Types which can be validated (source)
versionNextMinor - Converts vX.Y.N to vX.Y.(N+1) so v1.0.0 to v1.0.1 (source)
versionNoVee - Remove `v` from versions (source)
websiteScrape - Scrape a website. (source)
xdebugDisable - Disable Xdebug (source)
xdebugEnable - Enable Xdebug (source)
xdebugInstall - Install the xdebug PHP Debugger (source)
yarnInstall - Install yarn (source)
yumIsInstalled - Is yum installed? (source)

🛠️ Indexes · ⬅ Home