CheatPress

gum Glamorous shell scripts

Version 2.0.2 · source

gum, Postcard, light preview Light · Postcard 102 × 152 mm · PDF gum, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF gum, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
gum, A5, light preview Light · A5 148 × 210 mm · PDF gum, A5, dark preview Dark · A5 148 × 210 mm · PDF gum, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
gum, A4, light preview Light · A4 210 × 297 mm · PDF gum, A4, dark preview Dark · A4 210 × 297 mm · PDF gum, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
gum, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF gum, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF gum, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
gum, A3, light preview Light · A3 297 × 420 mm · PDF gum, A3, dark preview Dark · A3 297 × 420 mm · PDF gum, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
gum, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF gum, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF gum, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
gum, Letter, light preview Light · Letter 8.5 × 11 in · PDF gum, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF gum, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
gum, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF gum, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF gum, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

gum choose <a> <b>
Pick one option
gum filter
Fuzzy-pick from stdin
gum input
Ask for one line
gum confirm
Yes or no
gum spin -- <cmd>
Spinner while it runs
gum style <text>
Colour and borders
gum log <msg>
Levelled log line
gum write
Multi-line input

Concepts

  1. gum prompt choose, input, confirm
  2. Shell variable $(...) or if
  3. Script action spin, log, style

Choose and filter

gum choose <a> <b> <c>
Pick one from a list
gum choose --no-limit
Pick any number (stdin or args)
gum choose --limit <n>
Cap the number of picks
gum choose --header <text>
Title above the list
gum choose --height <n>
Visible rows of the list
gum filter
Fuzzy search lines from stdin
gum filter --limit <n>
Allow several matches
gum filter --placeholder <text>
Hint in the search box
gum file <dir>
Browse and pick a file
gum table < <file>.csv
Pick a row from CSV
Selected row is printed as comma-separated text; use cut to take a column.

Input

gum input
Read one line of text
gum input --placeholder <text>
Show a hint when empty
gum input --value <text>
Prefill the field
gum input --password
Hide typed characters
gum input --prompt <text>
Change the prompt marker
gum input --width <n>
Set field width
gum write
Multi-line text, Ctrl+D to finish
gum write --placeholder <text>
Hint for the text area

Confirm and run

gum confirm
Ask yes/no, exit 0 or 1
gum confirm && <cmd> || <cmd>
Branch on the answer
gum confirm "<question>"
Custom question text
gum confirm --affirmative <yes> --negative <no>
Rename the buttons
gum spin --title <text> -- <cmd>
Spinner while a command runs
gum spin --spinner <type>
Pick the animation (dot, line, moon)
gum spin --show-output -- <cmd>
Print command output after

Style and output

gum style <text>
Print styled text
gum style --foreground <n> <text>
Set text colour (0-255 or hex)
gum style --border double <text>
Draw a border
gum style --padding "<v> <h>" <text>
Pad inside the box
gum style --margin "<v> <h>" <text>
Space outside the box
gum style --width <n> --align center <text>
Fix width and align
gum join --vertical <a> <b>
Stack styled blocks
gum join --align center <a> <b>
Place blocks side by side
gum format <markdown>
Render markdown
gum format -t code
Syntax-highlight code from stdin
gum format -t emoji
Replace :name: with emoji
gum pager < <file>
Scroll long text
gum log --level <lvl> <msg>
Log with a level
gum log --structured <msg> <key> <val>
Add key-value pairs
gum log --time rfc822 <msg>
Prefix a timestamp

Environment

GUM_INPUT_PLACEHOLDER=<text>
Default placeholder for input
GUM_INPUT_PROMPT=<text>
Default prompt for input
GUM_INPUT_WIDTH=<n>
Default width for input

Recipes

Choose, confirm, act
BRANCH=$(git branch --format='%(refname:short)' | gum filter)gum confirm "Delete $BRANCH?" && git branch -D "$BRANCH"
Ask for a commit message
TYPE=$(gum choose fix feat docs chore)MSG=$(gum input --placeholder "summary")git commit -m "$TYPE: $MSG"
Long task with spinner
gum spin --spinner dot --title "Building..." -- make buildgum log --level info "build done"
Pick files then open
FILES=$(gum file . )$EDITOR "$FILES"