Skip to content

Dump Tools

Dump things for debugging

⬅ Parent

dumpEnvironmentUnsafe

Output the environment shamelessly (not secure, not recommended)

Usage

dumpEnvironmentUnsafe [ --maximum-length maximumLength ] [ --skip-env environmentVariable ] [ --show-skipped ] [ --help ]

Output the environment shamelessly (not secure, not recommended)

Arguments

  • --maximum-length maximumLength - PositiveInteger. Optional. The maximum number of characters to output for each environment variable.
  • --skip-env environmentVariable - EnvironmentVariable. Optional. Skip this environment variable (must match exactly).
  • --show-skipped - Flag. Show skipped environment variables.
  • --help - Flag. Optional. Display this help.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

dumpEnvironment

Output the environment but try to hide secure value

Usage

dumpEnvironment [ --maximum-length maximumLength ] [ --skip-env environmentVariable ] [ --show-skipped ] [ --secure-match matchString ] [ --secure-suffix secureSuffix  ] [ --help ]

Output the environment but try to hide secure value

Arguments

  • --maximum-length maximumLength - PositiveInteger. Optional. The maximum number of characters to output for each environment variable.
  • --skip-env environmentVariable - EnvironmentVariable. Optional. Skip this environment variable (must match exactly).
  • --show-skipped - Flag. Show skipped environment variables.
  • --secure-match matchString - String. Optional. If an environment variable matches any case-insensitive part of this string, then hide it. If nothing specified, uses a secret key and password. If one value is specified the list is reset to zero. To show all variables pass a blank or - value here.
  • --secure-suffix secureSuffix - EmptyString. Optional. Suffix to display after hidden arguments.
  • --help - Flag. Optional. Display this help.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

dumpPipe

Dump a pipe with a title and stats

Usage

dumpPipe [ --symbol symbol ] [ --tail ] [ --head ] [ --lines ] [ --vanish file ] [ name ]

Dump a pipe with a title and stats

Reads standard input

text

Writes to standard output

formatted text for debugging

Arguments

  • --symbol symbol - String. Optional. Symbol to place before each line. (Blank is ok).
  • --tail - Flag. Optional. Show the tail of the file and not the head when not enough can be shown.
  • --head - Flag. Optional. Show the head of the file when not enough can be shown. (default)
  • --lines - UnsignedInteger. Optional. Number of lines to show.
  • --vanish file - UnsignedInteger. Optional. Number of lines to show.
  • name - String. Optional. The item name or title of this output.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

dumpBinary

Dumps output as hex

Usage

dumpBinary

Dumps output as hex

Reads standard input

binary

Writes to standard output

formatted output set to ideal consoleColumns

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

dumpHex

Output to hex

Usage

dumpHex [ --size size ]

Output to hex

Arguments

  • --size size - Integer. Output at most size bytes of data.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

dumpFile

Output a file for debugging

Usage

dumpFile [ fileName0 ] [ --symbol symbolString ] [ --lines lineCount ] [ --help ]

Output a file for debugging

Reads standard input

text (optional)

Writes to standard output

formatted text (optional)

Arguments

  • fileName0 - File. Optional. File to dump.
  • --symbol symbolString - String. Optional. Prefix for each output line.
  • --lines lineCount - PositiveInteger. Optional. Number of lines to output.
  • --help - Flag. Optional. Display this help.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

dumpLoadAverages

Print the load averages

Usage

dumpLoadAverages [ --help ]

Print the load averages

Arguments

  • --help - Flag. Optional. Display this help.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

debuggingStack

Dump the function and include stacks and the current environment

Usage

debuggingStack [ -x ] [ --me ] [ --exit ]

Dump the function and include stacks and the current environment

Arguments

  • -x - Flag. Optional. Show exported variables. (verbose)
  • --me - Flag. Optional. Show calling function call stack frame.
  • --exit - Flag. Optional. Exit with code 0 after output.

Debugging settings

Append to the value of BUILD_DEBUG (a comma-delimited (,) list) and add these tokens to enable debugging:

  • debuggingStack - debuggingStack shows arguments passed (extra) and exports (optional flag) ALWAYS

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Environment

  • BUILD_DEBUG - CommaDelimitedList. Constant for turning debugging on during build to find errors in the build scripts. Enable debugging globally in the build scripts. Set to a comma (,) delimited list string to enable specific debugging, or true for ALL debugging, false (or blank) for NO debugging.

Requires

printf usageDocument throwArgument