GUM(1) A tool for glamorous shell scripts. GUM(1)

gum - A tool for glamorous shell scripts.

gum [options...] [argument...]

Show context-sensitive help.
Print the version number

Choose an option from a list of choices
OPTIONS
--cursor-prefix="• " Prefix to show on the cursor item (hidden if limit is 1)
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Prefix to show on item that corresponds to the cursor position
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Header value
Height of the list
Option delimiter when reading from STDIN
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Allows to set a delimiter, so options can be set as label:value
Maximum number of options to pick
Pick unlimited number of options (ignores limit)
Maintain the order of the selected options
Option delimiter when writing to STDOUT
Select the given option if there is only one
Prefix to show on selected items (hidden if limit is 1)
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Options that should start as selected (selects all if given '*')
Show help keybinds
Strip ANSI sequences when reading from STDIN
Timeout until choose returns selected element
Prefix to show on unselected items (hidden if limit is 1)
Ask a user to confirm an action
OPTIONS
--affirmative="Yes" The title of the affirmative action
Default confirmation action
The title of the negative action
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Show help key binds
Print prompt and chosen action to output
Timeout until confirm returns selected value or default if provided
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Pick a file from a folder
OPTIONS
-a, --all Show hidden and 'dot' files
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
The cursor character
Allow directories selection
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Allow files selection
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Header value
Maximum number of files to display
Show file permissions
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Show help key binds
Show file size
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Timeout until command aborts without a selection
Filter items from a list
OPTIONS
--cursor-text.align="left" Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Enable fuzzy matching; otherwise match from start of word
Sort fuzzy results by their scores
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Header value
Input height
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Character for selection
Option delimiter when reading from STDIN
Maximum number of options to pick
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Pick unlimited number of options (ignores limit)
Option delimiter when writing to STDOUT
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Placeholder value
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Prompt to display
Display from the bottom of the screen
Select the given option if there is only one
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Character to indicate selected items (hidden if limit is 1)
Options that should start as selected (selects all if given '*')
Show help keybinds
Sort fuzzy results by their scores
Only returns if anything matched. Otherwise return Filter
Strip ANSI sequences when reading from STDIN
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Timeout until filter command aborts
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Character to indicate unselected items (hidden if limit is 1)
Initial filter value
Input width
Format a string using a template
OPTIONS
-l, --language="" Programming language to parse code
Strip ANSI sequences when reading from STDIN
Glamour theme to use for markdown formatting
Format to use (markdown,template,code,emoji)
Prompt for some input
OPTIONS
--char-limit=400 Maximum value length (0 for no limit)
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Cursor mode
Text padding
Strikethrough text
Underline text
Text width
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Header value
Mask input characters
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Placeholder value
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Prompt to display
Show help keybinds
Strip ANSI sequences when reading from STDIN
Timeout until input aborts
Initial value (can also be passed via stdin)
Input width (0 for terminal width)
Join text vertically or horizontally
OPTIONS
--align="left" Text alignment
Join (potentially multi-line) strings horizontally
Join (potentially multi-line) strings vertically
Log messages to output
OPTIONS
-o, --file=STRING Log to file
Format message using printf
The log formatter to use
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
The log level to use
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Minimal level to show
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Prefix to print before the message
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Use structured logging
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
The time format to use (kitchen, layout, ansic, rfc822, etc...)
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Scroll through a file
OPTIONS
--align="left" Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Italicize text
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Text margin
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Text padding
Show line numbers
Soft wrap lines
Strikethrough text
Timeout until command exits
Underline text
Text width
Display spinner while running a command
OPTIONS
-a, --align="left" Alignment of spinner with regard to the title
Show output of command only if the command fails
Show or pipe output of command during execution (shows both STDOUT and STDERR)
Show STDERR errput
Show STDOUT output
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Spinner type
Timeout until spin command aborts
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Text to display to user while spinning
Apply coloring, borders, spacing to text
OPTIONS
--align="left" Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Strip ANSI sequences when reading from STDIN
Trim whitespaces on every input line
Underline text
Text width
Render a table of data
OPTIONS
--border.align="left" Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
border style
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Column names
Sets the number of expected fields per record
file path
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Table height
If LazyQuotes is true, a quote may appear in an unquoted field and a non-doubled quote may appear in a quoted field
static print
Which column number should be returned instead of whole row as string. Default=0 returns whole Row
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Row separator
Show help keybinds
Timeout until choose returns selected element
Column widths
Semver check current gum version
Prompt for long-form text
OPTIONS
--base.align="left" Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Maximum value length (0 for no limit)
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Cursor mode
Text padding
Strikethrough text
Underline text
Text width
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Header value
Text area height
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Maximum number of lines (0 for no limit)
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Placeholder value
Text Alignment
Background Color
Bold text
Border Background Color
Border Foreground Color
Border Style
Faint text
Foreground Color
Text height
Italicize text
Text margin
Text padding
Strikethrough text
Underline text
Text width
Prompt to display
Show cursor line
Show help key binds
Show line numbers
Strip ANSI sequences when reading from STDIN
Timeout until choose returns selected element
Initial value (can be passed via stdin)
Text area width (0 for terminal width)

(c) 2022-2024 Charmbracelet, Inc.

Released under MIT license.

2025-01-28 gum