GUM(1)

NAME
gum - A tool for glamorous shell scripts.

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

DESCRIPTION

OPTIONS

-h, --help
    Show context-sensitive help.

-v, --version
    Print the version number

COMMANDS

choose [<options> ...]
    Choose an option from a list of choices

OPTIONS
    --cursor-prefix="[•] " Prefix to show on the cursor item (hidden if limit is 1)

    --cursor.align="left"
        Text Alignment

    --cursor.background=""
        Background Color

    --cursor.bold
        Bold text

    --cursor.border-background=STRING
        Border Background Color

    --cursor.border-foreground=STRING
        Border Foreground Color

    --cursor.border="none"
        Border Style

    --cursor.faint
        Faint text

    --cursor.foreground="212"
        Foreground Color

    --cursor.height=INT
        Text height

    --cursor.italic
        Italicize text

    --cursor.margin="0 0"
        Text margin

    --cursor.padding="0 0"
        Text padding

    --cursor.strikethrough
        Strikethrough text

    --cursor.underline
        Underline text

    --cursor.width=INT
        Text width

    --cursor="> "
        Prefix to show on item that corresponds to the cursor position

    --height=10
        Height of the list

    --item.align="left"
        Text Alignment

    --item.background=""
        Background Color

    --item.bold
        Bold text

    --item.border-background=STRING
        Border Background Color

    --item.border-foreground=STRING
        Border Foreground Color

    --item.border="none"
        Border Style

    --item.faint
        Faint text

    --item.foreground=""
        Foreground Color

    --item.height=INT
        Text height

    --item.italic
        Italicize text

    --item.margin="0 0"
        Text margin

    --item.padding="0 0"
        Text padding

    --item.strikethrough
        Strikethrough text

    --item.underline
        Underline text

    --item.width=INT
        Text width

    --limit=1
        Maximum number of options to pick

    --no-limit
        Pick unlimited number of options (ignores limit)

    --selected-prefix="[✕] "
        Prefix to show on selected items (hidden if limit is 1)

    --selected.align="left"
        Text Alignment

    --selected.background=""
        Background Color

    --selected.bold
        Bold text

    --selected.border-background=STRING
        Border Background Color

    --selected.border-foreground=STRING
        Border Foreground Color

    --selected.border="none"
        Border Style

    --selected.faint
        Faint text

    --selected.foreground="212"
        Foreground Color

    --selected.height=INT
        Text height

    --selected.italic
        Italicize text

    --selected.margin="0 0"
        Text margin

    --selected.padding="0 0"
        Text padding

    --selected.strikethrough
        Strikethrough text

    --selected.underline
        Underline text

    --selected.width=INT
        Text width

    --unselected-prefix="[ ] "
        Prefix to show on selected items (hidden if limit is 1)

confirm [<prompt>]
    Ask a user to confirm an action

OPTIONS
    --affirmative="Yes" The title of the affirmative action

    --default
        Default confirmation action

    --negative="No"
        The title of the negative action

    --prompt.align="left"
        Text Alignment

    --prompt.background=""
        Background Color

    --prompt.bold
        Bold text

    --prompt.border-background=STRING
        Border Background Color

    --prompt.border-foreground=STRING
        Border Foreground Color

    --prompt.border="none"
        Border Style

    --prompt.faint
        Faint text

    --prompt.foreground=""
        Foreground Color

    --prompt.height=INT
        Text height

    --prompt.italic
        Italicize text

    --prompt.margin="1 0 0 0"
        Text margin

    --prompt.padding="0 0"
        Text padding

    --prompt.strikethrough
        Strikethrough text

    --prompt.underline
        Underline text

    --prompt.width=INT
        Text width

    --selected.align="left"
        Text Alignment

    --selected.background="212"
        Background Color

    --selected.bold
        Bold text

    --selected.border-background=STRING
        Border Background Color

    --selected.border-foreground=STRING
        Border Foreground Color

    --selected.border="none"
        Border Style

    --selected.faint
        Faint text

    --selected.foreground="230"
        Foreground Color

    --selected.height=INT
        Text height

    --selected.italic
        Italicize text

    --selected.margin="1 1"
        Text margin

    --selected.padding="0 3"
        Text padding

    --selected.strikethrough
        Strikethrough text

    --selected.underline
        Underline text

    --selected.width=INT
        Text width

    --timeout=0
        Timeout for confirmation

    --unselected.align="left"
        Text Alignment

    --unselected.background="235"
        Background Color

    --unselected.bold
        Bold text

    --unselected.border-background=STRING
        Border Background Color

    --unselected.border-foreground=STRING
        Border Foreground Color

    --unselected.border="none"
        Border Style

    --unselected.faint
        Faint text

    --unselected.foreground="254"
        Foreground Color

    --unselected.height=INT
        Text height

    --unselected.italic
        Italicize text

    --unselected.margin="1 1"
        Text margin

    --unselected.padding="0 3"
        Text padding

    --unselected.strikethrough
        Strikethrough text

    --unselected.underline
        Underline text

    --unselected.width=INT
        Text width

filter
    Filter items from a list

OPTIONS
    --height=0 Input height

    --indicator.align="left"
        Text Alignment

    --indicator.background=""
        Background Color

    --indicator.bold
        Bold text

    --indicator.border-background=STRING
        Border Background Color

    --indicator.border-foreground=STRING
        Border Foreground Color

    --indicator.border="none"
        Border Style

    --indicator.faint
        Faint text

    --indicator.foreground="212"
        Foreground Color

    --indicator.height=INT
        Text height

    --indicator.italic
        Italicize text

    --indicator.margin="0 0"
        Text margin

    --indicator.padding="0 0"
        Text padding

    --indicator.strikethrough
        Strikethrough text

    --indicator.underline
        Underline text

    --indicator.width=INT
        Text width

    --indicator="•"
        Character for selection

    --match.align="left"
        Text Alignment

    --match.background=""
        Background Color

    --match.bold
        Bold text

    --match.border-background=STRING
        Border Background Color

    --match.border-foreground=STRING
        Border Foreground Color

    --match.border="none"
        Border Style

    --match.faint
        Faint text

    --match.foreground="212"
        Foreground Color

    --match.height=INT
        Text height

    --match.italic
        Italicize text

    --match.margin="0 0"
        Text margin

    --match.padding="0 0"
        Text padding

    --match.strikethrough
        Strikethrough text

    --match.underline
        Underline text

    --match.width=INT
        Text width

    --placeholder="Filter..."
        Placeholder value

    --prompt.align="left"
        Text Alignment

    --prompt.background=""
        Background Color

    --prompt.bold
        Bold text

    --prompt.border-background=STRING
        Border Background Color

    --prompt.border-foreground=STRING
        Border Foreground Color

    --prompt.border="none"
        Border Style

    --prompt.faint
        Faint text

    --prompt.foreground="240"
        Foreground Color

    --prompt.height=INT
        Text height

    --prompt.italic
        Italicize text

    --prompt.margin="0 0"
        Text margin

    --prompt.padding="0 0"
        Text padding

    --prompt.strikethrough
        Strikethrough text

    --prompt.underline
        Underline text

    --prompt.width=INT
        Text width

    --prompt="> "
        Prompt to display

    --text.align="left"
        Text Alignment

    --text.background=""
        Background Color

    --text.bold
        Bold text

    --text.border-background=STRING
        Border Background Color

    --text.border-foreground=STRING
        Border Foreground Color

    --text.border="none"
        Border Style

    --text.faint
        Faint text

    --text.foreground=""
        Foreground Color

    --text.height=INT
        Text height

    --text.italic
        Italicize text

    --text.margin="0 0"
        Text margin

    --text.padding="0 0"
        Text padding

    --text.strikethrough
        Strikethrough text

    --text.underline
        Underline text

    --text.width=INT
        Text width

    --value=""
        Initial filter value

    --width=20
        Input width

format [<template> ...]
    Format a string using a template

OPTIONS
    -t, --type="markdown" Format to use (markdown,template,code,emoji)

input
    Prompt for some input

OPTIONS
    --char-limit=400 Maximum value length (0 for no limit)

    --cursor.align="left"
        Text Alignment

    --cursor.background=""
        Background Color

    --cursor.bold
        Bold text

    --cursor.border-background=STRING
        Border Background Color

    --cursor.border-foreground=STRING
        Border Foreground Color

    --cursor.border="none"
        Border Style

    --cursor.faint
        Faint text

    --cursor.foreground="212"
        Foreground Color

    --cursor.height=INT
        Text height

    --cursor.italic
        Italicize text

    --cursor.margin="0 0"
        Text margin

    --cursor.padding="0 0"
        Text padding

    --cursor.strikethrough
        Strikethrough text

    --cursor.underline
        Underline text

    --cursor.width=INT
        Text width

    --password
        Mask input characters

    --placeholder="Type something..."
        Placeholder value

    --prompt.align="left"
        Text Alignment

    --prompt.background=""
        Background Color

    --prompt.bold
        Bold text

    --prompt.border-background=STRING
        Border Background Color

    --prompt.border-foreground=STRING
        Border Foreground Color

    --prompt.border="none"
        Border Style

    --prompt.faint
        Faint text

    --prompt.foreground=""
        Foreground Color

    --prompt.height=INT
        Text height

    --prompt.italic
        Italicize text

    --prompt.margin="0 0"
        Text margin

    --prompt.padding="0 0"
        Text padding

    --prompt.strikethrough
        Strikethrough text

    --prompt.underline
        Underline text

    --prompt.width=INT
        Text width

    --prompt="> "
        Prompt to display

    --value=""
        Initial value (can also be passed via stdin)

    --width=40
        Input width

join <text> ...
    Join text vertically or horizontally

OPTIONS
    --align="left" Text alignment

    --horizontal
        Join (potentially multi-line) strings horizontally

    --vertical
        Join (potentially multi-line) strings vertically

spin <command> ...
    Display spinner while running a command

OPTIONS
    --show-output Show output of command

    --spinner.align="left"
        Text Alignment

    --spinner.background=""
        Background Color

    --spinner.bold
        Bold text

    --spinner.border-background=STRING
        Border Background Color

    --spinner.border-foreground=STRING
        Border Foreground Color

    --spinner.border="none"
        Border Style

    --spinner.faint
        Faint text

    --spinner.foreground="212"
        Foreground Color

    --spinner.height=INT
        Text height

    --spinner.italic
        Italicize text

    --spinner.margin="0 0"
        Text margin

    --spinner.padding="0 0"
        Text padding

    --spinner.strikethrough
        Strikethrough text

    --spinner.underline
        Underline text

    --spinner.width=INT
        Text width

    -s, --spinner="dot"
        Spinner type

    --title.align="left"
        Text Alignment

    --title.background=""
        Background Color

    --title.bold
        Bold text

    --title.border-background=STRING
        Border Background Color

    --title.border-foreground=STRING
        Border Foreground Color

    --title.border="none"
        Border Style

    --title.faint
        Faint text

    --title.foreground=""
        Foreground Color

    --title.height=INT
        Text height

    --title.italic
        Italicize text

    --title.margin="0 0"
        Text margin

    --title.padding="0 0"
        Text padding

    --title.strikethrough
        Strikethrough text

    --title.underline
        Underline text

    --title.width=INT
        Text width

    --title="Loading..."
        Text to display to user while spinning

style [<text> ...]
    Apply coloring, borders, spacing to text

OPTIONS
    --align="left" Text Alignment

    --background=""
        Background Color

    --bold
        Bold text

    --border-background=STRING
        Border Background Color

    --border-foreground=STRING
        Border Foreground Color

    --border="none"
        Border Style

    --faint
        Faint text

    --foreground=""
        Foreground Color

    --height=INT
        Text height

    --italic
        Italicize text

    --margin="0 0"
        Text margin

    --padding="0 0"
        Text padding

    --strikethrough
        Strikethrough text

    --underline
        Underline text

    --width=INT
        Text width

write
    Prompt for long-form text

OPTIONS
    --base.align="left" Text Alignment

    --base.background=""
        Background Color

    --base.bold
        Bold text

    --base.border-background=STRING
        Border Background Color

    --base.border-foreground=STRING
        Border Foreground Color

    --base.border="none"
        Border Style

    --base.faint
        Faint text

    --base.foreground=""
        Foreground Color

    --base.height=INT
        Text height

    --base.italic
        Italicize text

    --base.margin="0 0"
        Text margin

    --base.padding="0 0"
        Text padding

    --base.strikethrough
        Strikethrough text

    --base.underline
        Underline text

    --base.width=INT
        Text width

    --char-limit=400
        Maximum value length (0 for no limit)

    --cursor-line-number.align="left"
        Text Alignment

    --cursor-line-number.background=""
        Background Color

    --cursor-line-number.bold
        Bold text

    --cursor-line-number.border-background=STRING
        Border Background Color

    --cursor-line-number.border-foreground=STRING
        Border Foreground Color

    --cursor-line-number.border="none"
        Border Style

    --cursor-line-number.faint
        Faint text

    --cursor-line-number.foreground="7"
        Foreground Color

    --cursor-line-number.height=INT
        Text height

    --cursor-line-number.italic
        Italicize text

    --cursor-line-number.margin="0 0"
        Text margin

    --cursor-line-number.padding="0 0"
        Text padding

    --cursor-line-number.strikethrough
        Strikethrough text

    --cursor-line-number.underline
        Underline text

    --cursor-line-number.width=INT
        Text width

    --cursor-line.align="left"
        Text Alignment

    --cursor-line.background=""
        Background Color

    --cursor-line.bold
        Bold text

    --cursor-line.border-background=STRING
        Border Background Color

    --cursor-line.border-foreground=STRING
        Border Foreground Color

    --cursor-line.border="none"
        Border Style

    --cursor-line.faint
        Faint text

    --cursor-line.foreground=""
        Foreground Color

    --cursor-line.height=INT
        Text height

    --cursor-line.italic
        Italicize text

    --cursor-line.margin="0 0"
        Text margin

    --cursor-line.padding="0 0"
        Text padding

    --cursor-line.strikethrough
        Strikethrough text

    --cursor-line.underline
        Underline text

    --cursor-line.width=INT
        Text width

    --cursor.align="left"
        Text Alignment

    --cursor.background=""
        Background Color

    --cursor.bold
        Bold text

    --cursor.border-background=STRING
        Border Background Color

    --cursor.border-foreground=STRING
        Border Foreground Color

    --cursor.border="none"
        Border Style

    --cursor.faint
        Faint text

    --cursor.foreground="212"
        Foreground Color

    --cursor.height=INT
        Text height

    --cursor.italic
        Italicize text

    --cursor.margin="0 0"
        Text margin

    --cursor.padding="0 0"
        Text padding

    --cursor.strikethrough
        Strikethrough text

    --cursor.underline
        Underline text

    --cursor.width=INT
        Text width

    --end-of-buffer.align="left"
        Text Alignment

    --end-of-buffer.background=""
        Background Color

    --end-of-buffer.bold
        Bold text

    --end-of-buffer.border-background=STRING
        Border Background Color

    --end-of-buffer.border-foreground=STRING
        Border Foreground Color

    --end-of-buffer.border="none"
        Border Style

    --end-of-buffer.faint
        Faint text

    --end-of-buffer.foreground="0"
        Foreground Color

    --end-of-buffer.height=INT
        Text height

    --end-of-buffer.italic
        Italicize text

    --end-of-buffer.margin="0 0"
        Text margin

    --end-of-buffer.padding="0 0"
        Text padding

    --end-of-buffer.strikethrough
        Strikethrough text

    --end-of-buffer.underline
        Underline text

    --end-of-buffer.width=INT
        Text width

    --height=5
        Text area height

    --line-number.align="left"
        Text Alignment

    --line-number.background=""
        Background Color

    --line-number.bold
        Bold text

    --line-number.border-background=STRING
        Border Background Color

    --line-number.border-foreground=STRING
        Border Foreground Color

    --line-number.border="none"
        Border Style

    --line-number.faint
        Faint text

    --line-number.foreground="7"
        Foreground Color

    --line-number.height=INT
        Text height

    --line-number.italic
        Italicize text

    --line-number.margin="0 0"
        Text margin

    --line-number.padding="0 0"
        Text padding

    --line-number.strikethrough
        Strikethrough text

    --line-number.underline
        Underline text

    --line-number.width=INT
        Text width

    --placeholder.align="left"
        Text Alignment

    --placeholder.background=""
        Background Color

    --placeholder.bold
        Bold text

    --placeholder.border-background=STRING
        Border Background Color

    --placeholder.border-foreground=STRING
        Border Foreground Color

    --placeholder.border="none"
        Border Style

    --placeholder.faint
        Faint text

    --placeholder.foreground="240"
        Foreground Color

    --placeholder.height=INT
        Text height

    --placeholder.italic
        Italicize text

    --placeholder.margin="0 0"
        Text margin

    --placeholder.padding="0 0"
        Text padding

    --placeholder.strikethrough
        Strikethrough text

    --placeholder.underline
        Underline text

    --placeholder.width=INT
        Text width

    --placeholder="Write something..."
        Placeholder value

    --prompt.align="left"
        Text Alignment

    --prompt.background=""
        Background Color

    --prompt.bold
        Bold text

    --prompt.border-background=STRING
        Border Background Color

    --prompt.border-foreground=STRING
        Border Foreground Color

    --prompt.border="none"
        Border Style

    --prompt.faint
        Faint text

    --prompt.foreground="7"
        Foreground Color

    --prompt.height=INT
        Text height

    --prompt.italic
        Italicize text

    --prompt.margin="0 0"
        Text margin

    --prompt.padding="0 0"
        Text padding

    --prompt.strikethrough
        Strikethrough text

    --prompt.underline
        Underline text

    --prompt.width=INT
        Text width

    --prompt="┃ "
        Prompt to display

    --show-cursor-line
        Show cursor line

    --show-line-numbers
        Show line numbers

    --value=""
        Initial value (can be passed via stdin)

    --width=50
        Text area width

COPYRIGHT
(C) 2021-2022 Charmbracelet, Inc.

Released under MIT license.