.TH GUM 1 "2024-04-26" "gum" "A tool for glamorous shell scripts." .SH NAME gum - A tool for glamorous shell scripts\&. .SH SYNOPSIS \fBgum\fP [\fIoptions\&.\&.\&.\fP] [\fIargument\&.\&.\&.\fP] .SH DESCRIPTION .SH OPTIONS .TP \fB-h, --help\fP Show context-sensitive help\&. .TP \fB-v, --version\fP Print the version number .SH COMMANDS .TP \fBchoose [ \&.\&.\&.] [flags]\fP .RS 4 Choose an option from a list of choices .RE .TP \fBOPTIONS\fP .RS 4 \fB--cursor-prefix="• "\fP Prefix to show on the cursor item (hidden if limit is 1) .TP \fB--cursor\&.align="left"\fP Text Alignment .TP \fB--cursor\&.background=""\fP Background Color .TP \fB--cursor\&.bold\fP Bold text .TP \fB--cursor\&.border-background=""\fP Border Background Color .TP \fB--cursor\&.border-foreground=""\fP Border Foreground Color .TP \fB--cursor\&.border="none"\fP Border Style .TP \fB--cursor\&.faint\fP Faint text .TP \fB--cursor\&.foreground="212"\fP Foreground Color .TP \fB--cursor\&.height=0\fP Text height .TP \fB--cursor\&.italic\fP Italicize text .TP \fB--cursor\&.margin="0 0"\fP Text margin .TP \fB--cursor\&.padding="0 0"\fP Text padding .TP \fB--cursor\&.strikethrough\fP Strikethrough text .TP \fB--cursor\&.underline\fP Underline text .TP \fB--cursor\&.width=0\fP Text width .TP \fB--cursor="> "\fP Prefix to show on item that corresponds to the cursor position .TP \fB--header\&.align="left"\fP Text Alignment .TP \fB--header\&.background=""\fP Background Color .TP \fB--header\&.bold\fP Bold text .TP \fB--header\&.border-background=""\fP Border Background Color .TP \fB--header\&.border-foreground=""\fP Border Foreground Color .TP \fB--header\&.border="none"\fP Border Style .TP \fB--header\&.faint\fP Faint text .TP \fB--header\&.foreground="99"\fP Foreground Color .TP \fB--header\&.height=0\fP Text height .TP \fB--header\&.italic\fP Italicize text .TP \fB--header\&.margin="0 0"\fP Text margin .TP \fB--header\&.padding="0 0"\fP Text padding .TP \fB--header\&.strikethrough\fP Strikethrough text .TP \fB--header\&.underline\fP Underline text .TP \fB--header\&.width=0\fP Text width .TP \fB--header=""\fP Header value .TP \fB--height=10\fP Height of the list .TP \fB--item\&.align="left"\fP Text Alignment .TP \fB--item\&.background=""\fP Background Color .TP \fB--item\&.bold\fP Bold text .TP \fB--item\&.border-background=""\fP Border Background Color .TP \fB--item\&.border-foreground=""\fP Border Foreground Color .TP \fB--item\&.border="none"\fP Border Style .TP \fB--item\&.faint\fP Faint text .TP \fB--item\&.foreground=""\fP Foreground Color .TP \fB--item\&.height=0\fP Text height .TP \fB--item\&.italic\fP Italicize text .TP \fB--item\&.margin="0 0"\fP Text margin .TP \fB--item\&.padding="0 0"\fP Text padding .TP \fB--item\&.strikethrough\fP Strikethrough text .TP \fB--item\&.underline\fP Underline text .TP \fB--item\&.width=0\fP Text width .TP \fB--limit=1\fP Maximum number of options to pick .TP \fB--no-limit\fP Pick unlimited number of options (ignores limit) .TP \fB--ordered\fP Maintain the order of the selected options .TP \fB--select-if-one\fP Select the given option if there is only one .TP \fB--selected-prefix="✓ "\fP Prefix to show on selected items (hidden if limit is 1) .TP \fB--selected\&.align="left"\fP Text Alignment .TP \fB--selected\&.background=""\fP Background Color .TP \fB--selected\&.bold\fP Bold text .TP \fB--selected\&.border-background=""\fP Border Background Color .TP \fB--selected\&.border-foreground=""\fP Border Foreground Color .TP \fB--selected\&.border="none"\fP Border Style .TP \fB--selected\&.faint\fP Faint text .TP \fB--selected\&.foreground="212"\fP Foreground Color .TP \fB--selected\&.height=0\fP Text height .TP \fB--selected\&.italic\fP Italicize text .TP \fB--selected\&.margin="0 0"\fP Text margin .TP \fB--selected\&.padding="0 0"\fP Text padding .TP \fB--selected\&.strikethrough\fP Strikethrough text .TP \fB--selected\&.underline\fP Underline text .TP \fB--selected\&.width=0\fP Text width .TP \fB--selected=,\&.\&.\&.\fP Options that should start as selected .TP \fB--timeout=0\fP Timeout until choose returns selected element .TP \fB--unselected-prefix="• "\fP Prefix to show on unselected items (hidden if limit is 1) .RE .TP \fBconfirm [] [flags]\fP .RS 4 Ask a user to confirm an action .RE .TP \fBOPTIONS\fP .RS 4 \fB--affirmative="Yes"\fP The title of the affirmative action .TP \fB--default\fP Default confirmation action .TP \fB--negative="No"\fP The title of the negative action .TP \fB--prompt\&.align="left"\fP Text Alignment .TP \fB--prompt\&.background=""\fP Background Color .TP \fB--prompt\&.bold\fP Bold text .TP \fB--prompt\&.border-background=""\fP Border Background Color .TP \fB--prompt\&.border-foreground=""\fP Border Foreground Color .TP \fB--prompt\&.border="none"\fP Border Style .TP \fB--prompt\&.faint\fP Faint text .TP \fB--prompt\&.foreground=""\fP Foreground Color .TP \fB--prompt\&.height=0\fP Text height .TP \fB--prompt\&.italic\fP Italicize text .TP \fB--prompt\&.margin="1 0 0 1"\fP Text margin .TP \fB--prompt\&.padding="0 0"\fP Text padding .TP \fB--prompt\&.strikethrough\fP Strikethrough text .TP \fB--prompt\&.underline\fP Underline text .TP \fB--prompt\&.width=0\fP Text width .TP \fB--selected\&.align="left"\fP Text Alignment .TP \fB--selected\&.background="212"\fP Background Color .TP \fB--selected\&.bold\fP Bold text .TP \fB--selected\&.border-background=""\fP Border Background Color .TP \fB--selected\&.border-foreground=""\fP Border Foreground Color .TP \fB--selected\&.border="none"\fP Border Style .TP \fB--selected\&.faint\fP Faint text .TP \fB--selected\&.foreground="230"\fP Foreground Color .TP \fB--selected\&.height=0\fP Text height .TP \fB--selected\&.italic\fP Italicize text .TP \fB--selected\&.margin="0 1"\fP Text margin .TP \fB--selected\&.padding="0 3"\fP Text padding .TP \fB--selected\&.strikethrough\fP Strikethrough text .TP \fB--selected\&.underline\fP Underline text .TP \fB--selected\&.width=0\fP Text width .TP \fB--timeout=0\fP Timeout until confirm returns selected value or default if provided .TP \fB--unselected\&.align="left"\fP Text Alignment .TP \fB--unselected\&.background="235"\fP Background Color .TP \fB--unselected\&.bold\fP Bold text .TP \fB--unselected\&.border-background=""\fP Border Background Color .TP \fB--unselected\&.border-foreground=""\fP Border Foreground Color .TP \fB--unselected\&.border="none"\fP Border Style .TP \fB--unselected\&.faint\fP Faint text .TP \fB--unselected\&.foreground="254"\fP Foreground Color .TP \fB--unselected\&.height=0\fP Text height .TP \fB--unselected\&.italic\fP Italicize text .TP \fB--unselected\&.margin="0 1"\fP Text margin .TP \fB--unselected\&.padding="0 3"\fP Text padding .TP \fB--unselected\&.strikethrough\fP Strikethrough text .TP \fB--unselected\&.underline\fP Underline text .TP \fB--unselected\&.width=0\fP Text width .RE .TP \fBfile [] [flags]\fP .RS 4 Pick a file from a folder .RE .TP \fBOPTIONS\fP .RS 4 \fB-a, --all\fP Show hidden and 'dot' files .TP \fB--cursor\&.align="left"\fP Text Alignment .TP \fB--cursor\&.background=""\fP Background Color .TP \fB--cursor\&.bold\fP Bold text .TP \fB--cursor\&.border-background=""\fP Border Background Color .TP \fB--cursor\&.border-foreground=""\fP Border Foreground Color .TP \fB--cursor\&.border="none"\fP Border Style .TP \fB--cursor\&.faint\fP Faint text .TP \fB--cursor\&.foreground="212"\fP Foreground Color .TP \fB--cursor\&.height=0\fP Text height .TP \fB--cursor\&.italic\fP Italicize text .TP \fB--cursor\&.margin="0 0"\fP Text margin .TP \fB--cursor\&.padding="0 0"\fP Text padding .TP \fB--cursor\&.strikethrough\fP Strikethrough text .TP \fB--cursor\&.underline\fP Underline text .TP \fB--cursor\&.width=0\fP Text width .TP \fB-c, --cursor=">"\fP The cursor character .TP \fB--directory\fP Allow directories selection .TP \fB--directory\&.align="left"\fP Text Alignment .TP \fB--directory\&.background=""\fP Background Color .TP \fB--directory\&.bold\fP Bold text .TP \fB--directory\&.border-background=""\fP Border Background Color .TP \fB--directory\&.border-foreground=""\fP Border Foreground Color .TP \fB--directory\&.border="none"\fP Border Style .TP \fB--directory\&.faint\fP Faint text .TP \fB--directory\&.foreground="99"\fP Foreground Color .TP \fB--directory\&.height=0\fP Text height .TP \fB--directory\&.italic\fP Italicize text .TP \fB--directory\&.margin="0 0"\fP Text margin .TP \fB--directory\&.padding="0 0"\fP Text padding .TP \fB--directory\&.strikethrough\fP Strikethrough text .TP \fB--directory\&.underline\fP Underline text .TP \fB--directory\&.width=0\fP Text width .TP \fB--file\fP Allow files selection .TP \fB--file-size\&.align="right"\fP Text Alignment .TP \fB--file-size\&.background=""\fP Background Color .TP \fB--file-size\&.bold\fP Bold text .TP \fB--file-size\&.border-background=""\fP Border Background Color .TP \fB--file-size\&.border-foreground=""\fP Border Foreground Color .TP \fB--file-size\&.border="none"\fP Border Style .TP \fB--file-size\&.faint\fP Faint text .TP \fB--file-size\&.foreground="240"\fP Foreground Color .TP \fB--file-size\&.height=0\fP Text height .TP \fB--file-size\&.italic\fP Italicize text .TP \fB--file-size\&.margin="0 0"\fP Text margin .TP \fB--file-size\&.padding="0 0"\fP Text padding .TP \fB--file-size\&.strikethrough\fP Strikethrough text .TP \fB--file-size\&.underline\fP Underline text .TP \fB--file-size\&.width=8\fP Text width .TP \fB--file\&.align="left"\fP Text Alignment .TP \fB--file\&.background=""\fP Background Color .TP \fB--file\&.bold\fP Bold text .TP \fB--file\&.border-background=""\fP Border Background Color .TP \fB--file\&.border-foreground=""\fP Border Foreground Color .TP \fB--file\&.border="none"\fP Border Style .TP \fB--file\&.faint\fP Faint text .TP \fB--file\&.foreground=""\fP Foreground Color .TP \fB--file\&.height=0\fP Text height .TP \fB--file\&.italic\fP Italicize text .TP \fB--file\&.margin="0 0"\fP Text margin .TP \fB--file\&.padding="0 0"\fP Text padding .TP \fB--file\&.strikethrough\fP Strikethrough text .TP \fB--file\&.underline\fP Underline text .TP \fB--file\&.width=0\fP Text width .TP \fB--height=10\fP Maximum number of files to display .TP \fB--permissions\&.align="left"\fP Text Alignment .TP \fB--permissions\&.background=""\fP Background Color .TP \fB--permissions\&.bold\fP Bold text .TP \fB--permissions\&.border-background=""\fP Border Background Color .TP \fB--permissions\&.border-foreground=""\fP Border Foreground Color .TP \fB--permissions\&.border="none"\fP Border Style .TP \fB--permissions\&.faint\fP Faint text .TP \fB--permissions\&.foreground="244"\fP Foreground Color .TP \fB--permissions\&.height=0\fP Text height .TP \fB--permissions\&.italic\fP Italicize text .TP \fB--permissions\&.margin="0 0"\fP Text margin .TP \fB--permissions\&.padding="0 0"\fP Text padding .TP \fB--permissions\&.strikethrough\fP Strikethrough text .TP \fB--permissions\&.underline\fP Underline text .TP \fB--permissions\&.width=0\fP Text width .TP \fB--selected\&.align="left"\fP Text Alignment .TP \fB--selected\&.background=""\fP Background Color .TP \fB--selected\&.bold\fP Bold text .TP \fB--selected\&.border-background=""\fP Border Background Color .TP \fB--selected\&.border-foreground=""\fP Border Foreground Color .TP \fB--selected\&.border="none"\fP Border Style .TP \fB--selected\&.faint\fP Faint text .TP \fB--selected\&.foreground="212"\fP Foreground Color .TP \fB--selected\&.height=0\fP Text height .TP \fB--selected\&.italic\fP Italicize text .TP \fB--selected\&.margin="0 0"\fP Text margin .TP \fB--selected\&.padding="0 0"\fP Text padding .TP \fB--selected\&.strikethrough\fP Strikethrough text .TP \fB--selected\&.underline\fP Underline text .TP \fB--selected\&.width=0\fP Text width .TP \fB--symlink\&.align="left"\fP Text Alignment .TP \fB--symlink\&.background=""\fP Background Color .TP \fB--symlink\&.bold\fP Bold text .TP \fB--symlink\&.border-background=""\fP Border Background Color .TP \fB--symlink\&.border-foreground=""\fP Border Foreground Color .TP \fB--symlink\&.border="none"\fP Border Style .TP \fB--symlink\&.faint\fP Faint text .TP \fB--symlink\&.foreground="36"\fP Foreground Color .TP \fB--symlink\&.height=0\fP Text height .TP \fB--symlink\&.italic\fP Italicize text .TP \fB--symlink\&.margin="0 0"\fP Text margin .TP \fB--symlink\&.padding="0 0"\fP Text padding .TP \fB--symlink\&.strikethrough\fP Strikethrough text .TP \fB--symlink\&.underline\fP Underline text .TP \fB--symlink\&.width=0\fP Text width .TP \fB--timeout=0\fP Timeout until command aborts without a selection .RE .TP \fBfilter [ \&.\&.\&.] [flags]\fP .RS 4 Filter items from a list .RE .TP \fBOPTIONS\fP .RS 4 \fB--cursor-text\&.align="left"\fP Text Alignment .TP \fB--cursor-text\&.background=""\fP Background Color .TP \fB--cursor-text\&.bold\fP Bold text .TP \fB--cursor-text\&.border-background=""\fP Border Background Color .TP \fB--cursor-text\&.border-foreground=""\fP Border Foreground Color .TP \fB--cursor-text\&.border="none"\fP Border Style .TP \fB--cursor-text\&.faint\fP Faint text .TP \fB--cursor-text\&.foreground=""\fP Foreground Color .TP \fB--cursor-text\&.height=0\fP Text height .TP \fB--cursor-text\&.italic\fP Italicize text .TP \fB--cursor-text\&.margin="0 0"\fP Text margin .TP \fB--cursor-text\&.padding="0 0"\fP Text padding .TP \fB--cursor-text\&.strikethrough\fP Strikethrough text .TP \fB--cursor-text\&.underline\fP Underline text .TP \fB--cursor-text\&.width=0\fP Text width .TP \fB--fuzzy\fP Enable fuzzy matching .TP \fB--header\&.align="left"\fP Text Alignment .TP \fB--header\&.background=""\fP Background Color .TP \fB--header\&.bold\fP Bold text .TP \fB--header\&.border-background=""\fP Border Background Color .TP \fB--header\&.border-foreground=""\fP Border Foreground Color .TP \fB--header\&.border="none"\fP Border Style .TP \fB--header\&.faint\fP Faint text .TP \fB--header\&.foreground="240"\fP Foreground Color .TP \fB--header\&.height=0\fP Text height .TP \fB--header\&.italic\fP Italicize text .TP \fB--header\&.margin="0 0"\fP Text margin .TP \fB--header\&.padding="0 0"\fP Text padding .TP \fB--header\&.strikethrough\fP Strikethrough text .TP \fB--header\&.underline\fP Underline text .TP \fB--header\&.width=0\fP Text width .TP \fB--header=""\fP Header value .TP \fB--height=0\fP Input height .TP \fB--indicator\&.align="left"\fP Text Alignment .TP \fB--indicator\&.background=""\fP Background Color .TP \fB--indicator\&.bold\fP Bold text .TP \fB--indicator\&.border-background=""\fP Border Background Color .TP \fB--indicator\&.border-foreground=""\fP Border Foreground Color .TP \fB--indicator\&.border="none"\fP Border Style .TP \fB--indicator\&.faint\fP Faint text .TP \fB--indicator\&.foreground="212"\fP Foreground Color .TP \fB--indicator\&.height=0\fP Text height .TP \fB--indicator\&.italic\fP Italicize text .TP \fB--indicator\&.margin="0 0"\fP Text margin .TP \fB--indicator\&.padding="0 0"\fP Text padding .TP \fB--indicator\&.strikethrough\fP Strikethrough text .TP \fB--indicator\&.underline\fP Underline text .TP \fB--indicator\&.width=0\fP Text width .TP \fB--indicator="•"\fP Character for selection .TP \fB--limit=1\fP Maximum number of options to pick .TP \fB--match\&.align="left"\fP Text Alignment .TP \fB--match\&.background=""\fP Background Color .TP \fB--match\&.bold\fP Bold text .TP \fB--match\&.border-background=""\fP Border Background Color .TP \fB--match\&.border-foreground=""\fP Border Foreground Color .TP \fB--match\&.border="none"\fP Border Style .TP \fB--match\&.faint\fP Faint text .TP \fB--match\&.foreground="212"\fP Foreground Color .TP \fB--match\&.height=0\fP Text height .TP \fB--match\&.italic\fP Italicize text .TP \fB--match\&.margin="0 0"\fP Text margin .TP \fB--match\&.padding="0 0"\fP Text padding .TP \fB--match\&.strikethrough\fP Strikethrough text .TP \fB--match\&.underline\fP Underline text .TP \fB--match\&.width=0\fP Text width .TP \fB--no-limit\fP Pick unlimited number of options (ignores limit) .TP \fB--placeholder\&.align="left"\fP Text Alignment .TP \fB--placeholder\&.background=""\fP Background Color .TP \fB--placeholder\&.bold\fP Bold text .TP \fB--placeholder\&.border-background=""\fP Border Background Color .TP \fB--placeholder\&.border-foreground=""\fP Border Foreground Color .TP \fB--placeholder\&.border="none"\fP Border Style .TP \fB--placeholder\&.faint\fP Faint text .TP \fB--placeholder\&.foreground="240"\fP Foreground Color .TP \fB--placeholder\&.height=0\fP Text height .TP \fB--placeholder\&.italic\fP Italicize text .TP \fB--placeholder\&.margin="0 0"\fP Text margin .TP \fB--placeholder\&.padding="0 0"\fP Text padding .TP \fB--placeholder\&.strikethrough\fP Strikethrough text .TP \fB--placeholder\&.underline\fP Underline text .TP \fB--placeholder\&.width=0\fP Text width .TP \fB--placeholder="Filter\&.\&.\&."\fP Placeholder value .TP \fB--prompt\&.align="left"\fP Text Alignment .TP \fB--prompt\&.background=""\fP Background Color .TP \fB--prompt\&.bold\fP Bold text .TP \fB--prompt\&.border-background=""\fP Border Background Color .TP \fB--prompt\&.border-foreground=""\fP Border Foreground Color .TP \fB--prompt\&.border="none"\fP Border Style .TP \fB--prompt\&.faint\fP Faint text .TP \fB--prompt\&.foreground="240"\fP Foreground Color .TP \fB--prompt\&.height=0\fP Text height .TP \fB--prompt\&.italic\fP Italicize text .TP \fB--prompt\&.margin="0 0"\fP Text margin .TP \fB--prompt\&.padding="0 0"\fP Text padding .TP \fB--prompt\&.strikethrough\fP Strikethrough text .TP \fB--prompt\&.underline\fP Underline text .TP \fB--prompt\&.width=0\fP Text width .TP \fB--prompt="> "\fP Prompt to display .TP \fB--reverse\fP Display from the bottom of the screen .TP \fB--select-if-one\fP Select the given option if there is only one .TP \fB--selected-indicator\&.align="left"\fP Text Alignment .TP \fB--selected-indicator\&.background=""\fP Background Color .TP \fB--selected-indicator\&.bold\fP Bold text .TP \fB--selected-indicator\&.border-background=""\fP Border Background Color .TP \fB--selected-indicator\&.border-foreground=""\fP Border Foreground Color .TP \fB--selected-indicator\&.border="none"\fP Border Style .TP \fB--selected-indicator\&.faint\fP Faint text .TP \fB--selected-indicator\&.foreground="212"\fP Foreground Color .TP \fB--selected-indicator\&.height=0\fP Text height .TP \fB--selected-indicator\&.italic\fP Italicize text .TP \fB--selected-indicator\&.margin="0 0"\fP Text margin .TP \fB--selected-indicator\&.padding="0 0"\fP Text padding .TP \fB--selected-indicator\&.strikethrough\fP Strikethrough text .TP \fB--selected-indicator\&.underline\fP Underline text .TP \fB--selected-indicator\&.width=0\fP Text width .TP \fB--selected-prefix=" ◉ "\fP Character to indicate selected items (hidden if limit is 1) .TP \fB--sort\fP Sort the results .TP \fB--strict\fP Only returns if anything matched\&. Otherwise return Filter .TP \fB--text\&.align="left"\fP Text Alignment .TP \fB--text\&.background=""\fP Background Color .TP \fB--text\&.bold\fP Bold text .TP \fB--text\&.border-background=""\fP Border Background Color .TP \fB--text\&.border-foreground=""\fP Border Foreground Color .TP \fB--text\&.border="none"\fP Border Style .TP \fB--text\&.faint\fP Faint text .TP \fB--text\&.foreground=""\fP Foreground Color .TP \fB--text\&.height=0\fP Text height .TP \fB--text\&.italic\fP Italicize text .TP \fB--text\&.margin="0 0"\fP Text margin .TP \fB--text\&.padding="0 0"\fP Text padding .TP \fB--text\&.strikethrough\fP Strikethrough text .TP \fB--text\&.underline\fP Underline text .TP \fB--text\&.width=0\fP Text width .TP \fB--timeout=0\fP Timeout until filter command aborts .TP \fB--unselected-prefix\&.align="left"\fP Text Alignment .TP \fB--unselected-prefix\&.background=""\fP Background Color .TP \fB--unselected-prefix\&.bold\fP Bold text .TP \fB--unselected-prefix\&.border-background=""\fP Border Background Color .TP \fB--unselected-prefix\&.border-foreground=""\fP Border Foreground Color .TP \fB--unselected-prefix\&.border="none"\fP Border Style .TP \fB--unselected-prefix\&.faint\fP Faint text .TP \fB--unselected-prefix\&.foreground="240"\fP Foreground Color .TP \fB--unselected-prefix\&.height=0\fP Text height .TP \fB--unselected-prefix\&.italic\fP Italicize text .TP \fB--unselected-prefix\&.margin="0 0"\fP Text margin .TP \fB--unselected-prefix\&.padding="0 0"\fP Text padding .TP \fB--unselected-prefix\&.strikethrough\fP Strikethrough text .TP \fB--unselected-prefix\&.underline\fP Underline text .TP \fB--unselected-prefix\&.width=0\fP Text width .TP \fB--unselected-prefix=" ○ "\fP Character to indicate unselected items (hidden if limit is 1) .TP \fB--value=""\fP Initial filter value .TP \fB--width=20\fP Input width .RE .TP \fBformat [