Gum

The gum format command allows you to transform plain text into human-readable, styled output. It supports four primary parseable formats via the --type flag:

1. Markdown: Renders input as styled Markdown text (powered by Glamour).
2. Code: Renders code snippets with syntax highlighting (powered by Chroma via Glamour).
3. Template: Renders styled input using string templates (powered by Termenv).
4. Emoji: Parses and renders emojis from :name: syntax (powered by Goldmark Emoji via Glamour).

Input can be provided either as direct command-line arguments or via stdin.

gum format --type <format> [input]

Gum options and styles can be customized using command-line --flags or $ENVIRONMENT_VARIABLES. Flags take precedence over environment variables.

Using flags:

gum input --cursor.foreground "#FF0" --prompt.foreground "#0FF" --placeholder "What's up?" --prompt "* " --width 80 --value "Not much, hby?"

Using environment variables:

export GUM_INPUT_CURSOR_FOREGROUND="#FF0"
export GUM_INPUT_PROMPT_FOREGROUND="#0FF"
export GUM_INPUT_PLACEHOLDER="What's up?"
export GUM_INPUT_PROMPT="* "
export GUM_INPUT_WIDTH=80

# --flags can override values set with environment
gum input

To install Gum on Debian or Ubuntu-based systems, add the Charm repository and install via apt:

sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://repo.charm.sh/apt/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/charm.gpg
echo "deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * *" | sudo tee /etc/apt/sources.list.d/charm.list
sudo apt update && sudo apt install gum

On FreeBSD, you can install via packages or build from ports:

# packages
sudo pkg install gum

# ports
cd /usr/ports/devel/gum && sudo make install clean

To install Gum on Fedora, RHEL, or OpenSuse, configure the Charm repository and use yum or zypper:

echo '[charm]
name=Charm
baseurl=https://repo.charm.sh/yum/
enabled=1
gpgcheck=1
gpgkey=https://repo.charm.sh/yum/gpg.key' | sudo tee /etc/yum.repos.d/charm.repo
sudo rpm --import https://repo.charm.sh/yum/gpg.key

# yum
sudo yum install gum

# zypper
sudo zypper refresh
sudo zypper install gum

You can install Gum using various package managers depending on your operating system or by using Go.

# macOS or Linux
brew install gum

# Arch Linux
pacman -S gum

# Fedora or EPEL 10
dnf install gum

# Nix
nix-env -iA nixpkgs.gum

# Flox
flox install gum

# Windows (via WinGet or Scoop)
winget install charmbracelet.gum
scoop install charm-gum

# Using Go
go install github.com/charmbracelet/gum@latest

Gum is a command-line tool designed to make shell scripts more 'glamorous' by providing interactive components. It is invoked via the gum binary. The CLI uses a subcommand structure (managed by kong) to provide various interactive utilities like spinners, inputs, and selections.

# Example of how you would typically use the gum command in a shell script
# (Note: specific subcommands are defined in other parts of the repository)

gum input
gum confirm
gum spin

Tables are rendered using the Markdown engine (Glamour). Ensure your input follows standard Markdown table syntax.

echo '| Bubble Gum Flavor | Price |
| ----------------- | ----- |
| Strawberry        | $0.99 |
| Cherry            | $0.50 |' | gum format --type markdown

The write command prompts for multi-line text. Users can complete the entry by pressing ctrl+d.

gum write > story.txt

The spin command displays a spinner while a command or script is running. The spinner stops automatically when the command exits. Use --show-output to view or pipe the command's output.

Available spinner types: line, dot, minidot, jump, pulse, points, globe, moon, monkey, meter, hamburger.

gum spin --spinner dot --title "Buying Bubble Gum..." -- sleep 5

The table command renders tabular data and allows the user to select a row.

gum table < flavors.csv | cut -d ',' -f 1