2022-07-07 20:26:35 +03:00
# Gum
2022-06-11 01:07:40 +03:00
2022-07-08 20:47:21 +03:00
< p >
< a href = "https://github.com/charmbracelet/gum/releases" > < img src = "https://img.shields.io/github/release/charmbracelet/gum.svg" alt = "Latest Release" > < / a >
< a href = "https://pkg.go.dev/github.com/charmbracelet/gum?tab=doc" > < img src = "https://godoc.org/github.com/golang/gddo?status.svg" alt = "GoDoc" > < / a >
< a href = "https://github.com/charmbracelet/gum/actions" > < img src = "https://github.com/charmbracelet/gum/workflows/build/badge.svg" alt = "Build Status" > < / a >
< / p >
2022-07-08 06:21:31 +03:00
Gum is a collection of command-line utilities that make your shell scripts a
little more glamorous. It gives you the power of
2022-07-07 20:26:35 +03:00
[Bubbles ](https://github.com/charmbracelet/bubbles ) and
[Lip Gloss ](https://github.com/charmbracelet/lipgloss ) without needing to write
any Go code.
2022-07-11 20:30:57 +03:00
```bash
# Prompt users for input
NAME=$(gum input --placeholder "What is your name?")
# Style some text
gum style --foreground 212 --padding "1 4" \
--border double --border-foreground 57 \
"Nice to meet you, $NAME."
# Do some work while spinning
gum spin --title "Taking a nap..." --color 212 -- sleep 5
# Fuzzy find a file or directory
find . -type f | gum filter
```
feat: `gum choose`, pick from a list of choices
gum choose allows the user to be prompted for a choice from a list of choices.
For example, let's ask the user to pick a card from a deck.
gum choose --height 15 {Ace,King,Queen,Jack,Ten,Nine,Eight,Seven,Six,Five,Four,Three,Two}" of "{Spades,Hearts,Clubs,Diamonds}
2022-07-11 23:17:47 +03:00
The following example is running from a [single bash script ](./examples/demo.sh ).
2022-07-07 22:22:31 +03:00
< img src = "https://stuff.charm.sh/gum/gum.gif" width = "900" alt = "Shell running the Gum examples/demo.sh script" >
2022-06-11 01:07:40 +03:00
2022-07-08 20:31:54 +03:00
## Installation
Use a package manager:
```bash
# macOS or Linux
brew tap charmbracelet/tap & & brew install charmbracelet/tap/gum
2022-07-09 00:34:51 +03:00
# Arch Linux (btw)
2022-07-08 20:31:54 +03:00
pacman -S gum
# Nix
nix-env -iA nixpkgs.gum
# Debian/Ubuntu
2022-07-09 00:34:51 +03:00
echo 'deb [trusted=yes] https://repo.charm.sh/apt/ /' \
| sudo tee /etc/apt/sources.list.d/charm.list
2022-07-08 20:31:54 +03:00
sudo apt update & & sudo apt install gum
# Fedora
echo '[charm]
name=Charm
baseurl=https://repo.charm.sh/yum/
enabled=1
gpgcheck=0' | sudo tee /etc/yum.repos.d/charm.repo
sudo yum install gum
```
Or download it:
* [Packages][releases] are available in Debian and RPM formats
* [Binaries][releases] are available for Linux, macOS, and Windows
Or just install it with `go` :
```bash
go install github.com/charmbracelet/gum@latest
```
[releases]: https://github.com/charmbracelet/gum/releases
2022-06-11 01:07:40 +03:00
## Interaction
#### Input
Prompt your users for input with a simple command.
```bash
2022-07-07 20:26:35 +03:00
gum input > answer.text
2022-06-11 01:07:40 +03:00
```
2022-07-13 06:44:06 +03:00
< img src = "https://stuff.charm.sh/gum/input.gif" width = "350" alt = "Shell running gum input typing I love bubble gum <3" >
2022-07-08 06:21:31 +03:00
#### Write
Prompt your users to write some multi-line text.
```bash
gum write > story.text
```
2022-07-13 20:22:37 +03:00
< img src = "https://stuff.charm.sh/gum/write.gif" width = "600" alt = "Shell running gum write typing My favorite flavors are:" >
2022-07-13 06:44:06 +03:00
2022-07-08 20:58:14 +03:00
#### Filter
2022-06-11 01:07:40 +03:00
Allow your users to filter through a list of options by fuzzy searching.
```bash
2022-07-07 20:26:35 +03:00
echo Strawberry >> flavors.text
echo Banana >> flavors.text
2022-07-06 22:24:26 +03:00
echo Cherry >> flavors.text
2022-07-08 20:58:14 +03:00
cat flavors.text | gum filter > selection.text
2022-06-11 01:07:40 +03:00
```
2022-07-13 20:22:37 +03:00
< img src = "https://stuff.charm.sh/gum/filter.gif" width = "600" alt = "Shell running gum filter on different bubble gum flavors" >
2022-07-13 06:44:06 +03:00
feat: `gum choose`, pick from a list of choices
gum choose allows the user to be prompted for a choice from a list of choices.
For example, let's ask the user to pick a card from a deck.
gum choose --height 15 {Ace,King,Queen,Jack,Ten,Nine,Eight,Seven,Six,Five,Four,Three,Two}" of "{Spades,Hearts,Clubs,Diamonds}
2022-07-11 23:17:47 +03:00
#### Choose
Ask your users to choose an option from a list of choices.
```bash
echo "Pick a card, any card..."
CARD=$(gum choose --height 15 {{A,K,Q,J},{10..2}}" "{♠,♥,♣,♦})
echo "Was your card the $CARD?"
```
2022-07-13 20:22:37 +03:00
< img src = "https://stuff.charm.sh/gum/choose.gif" width = "600" alt = "Shell running gum choose on a deck of cards, picking the Ace of Hearts" >
2022-07-13 06:44:06 +03:00
2022-07-13 20:14:59 +03:00
You can also set a limit on the number of items to choose with the `--limit` flag.
```bash
echo "Pick your top 5 songs."
cat songs.txt | gum choose --limit 5
```
Or, allow any number of selections with the `--no-limit` flag.
```bash
echo "What do you need from the grocery store?"
cat foods.txt | gum choose --no-limit
```
2022-07-08 06:21:31 +03:00
#### Progress
2022-06-11 01:07:40 +03:00
2022-07-07 20:26:35 +03:00
Display a progress bar while loading. The following command will display a
progress bar and increment the progress by 10% every 1 second. Thus, taking 10
seconds to complete the progress bar.
2022-06-11 01:07:40 +03:00
```bash
2022-07-07 20:26:35 +03:00
gum progress --increment 0.1 --interval 1s
2022-06-11 01:07:40 +03:00
```
2022-07-13 06:44:06 +03:00
< img src = "https://stuff.charm.sh/gum/progress.gif" width = "600" alt = "Shell running gum progress" >
2022-06-11 01:07:40 +03:00
#### Spinners
Display a spinner while taking some running action. We specify the command to
run while showing the spinner, the spinner will automatically stop after the
command exits.
```bash
2022-07-07 20:26:35 +03:00
gum spin --spinner dot --title "Buying Bubble Gum..." -- sleep 5
2022-06-11 01:07:40 +03:00
```
2022-07-13 20:22:37 +03:00
< img src = "https://stuff.charm.sh/gum/spin.gif?cache=1" width = "600" alt = "Shell running gum spin while sleeping for 5 seconds" >
2022-07-13 06:44:06 +03:00
2022-07-08 06:21:31 +03:00
## Styling and Layout
2022-06-11 01:07:40 +03:00
2022-07-08 06:21:31 +03:00
#### Style
2022-06-11 01:07:40 +03:00
Pretty print any string with any layout with one command.
```bash
2022-07-07 20:26:35 +03:00
gum style \
2022-07-13 21:45:44 +03:00
--foreground 212 --border-foreground 212 --border double \
--align center --width 50 --margin "1 2" --padding "2 4" \
'Bubble Gum (1¢)' 'So sweet and so fresh!'
2022-06-11 01:07:40 +03:00
```
2022-07-13 21:45:44 +03:00
< img src = "https://stuff.charm.sh/gum/style.png?cache=1" width = "600" alt = "Bubble Gum, So sweet and so fresh!" >
2022-06-11 01:07:40 +03:00
2022-07-08 06:21:31 +03:00
#### Join
Combine text vertically or horizontally with a single command, use this command
with `gum style` to build layouts and pretty output.
Note: It's important to wrap the output of `gum style` in quotes to ensure new
lines (`\n`) are part of a single argument passed to the ` join` command.
```bash
2022-07-13 21:45:44 +03:00
I=$(gum style --padding "1 5" --border double --border-foreground 212 "I")
LOVE=$(gum style --padding "1 4" --border double --border-foreground 57 "LOVE")
BUBBLE=$(gum style --padding "1 8" --border double --border-foreground 255 "Bubble")
GUM=$(gum style --padding "1 5" --border double --border-foreground 240 "Gum")
2022-07-08 06:29:18 +03:00
I_LOVE=$(gum join "$I" "$LOVE")
BUBBLE_GUM=$(gum join "$BUBBLE" "$GUM")
gum join --align center --vertical "$I_LOVE" "$BUBBLE_GUM"
2022-07-08 06:21:31 +03:00
```
2022-07-13 21:45:44 +03:00
< img src = "https://stuff.charm.sh/gum/join.png" width = "600" alt = "I LOVE Bubble Gum written out in four boxes with double borders around them." >
2022-07-08 06:21:31 +03:00
2022-07-15 18:01:19 +03:00
#### Format
Format allows you to take some text and stylize it. `gum format` can parse
markdown, code, template strings, and emoji strings.
For example, we can output a markdown list with the following command:
```bash
2022-07-15 18:14:38 +03:00
gum format -- "# Gum Formats" "- Markdown" "- Code" "- Template" "- Emoji"
2022-07-15 18:01:19 +03:00
echo "# Gum Formats\n- Markdown\n- Code\n- Template\n- Emoji" | gum format
```
2022-07-15 18:14:38 +03:00
< img src = "https://stuff.charm.sh/gum/format-markdown.png" width = "250" alt = "Format markdown displaying a markdown list with content of different possible formats" >
Apply syntax highlighting to code with `gum format -t code` :
2022-07-15 18:01:19 +03:00
```bash
cat main.go | gum format -t code
```
2022-07-15 18:14:38 +03:00
< img src = "https://stuff.charm.sh/gum/format-code.png" width = "400" alt = "Format code command displaying a simple Hello, world! Go program with syntax highlighting." >
Render a template string with `gum format -t template` :
2022-07-15 18:01:19 +03:00
```bash
2022-07-15 18:14:38 +03:00
echo '{{ Bold "Tasty" }} {{ Italic "Bubble" }} {{ Color "99" "0" " Gum " }}' \
| gum format -t template
2022-07-15 18:01:19 +03:00
```
2022-07-15 18:14:38 +03:00
< img src = "https://stuff.charm.sh/gum/format-template.png" width = "400" alt = "Format template command displaying Tasty Bubble Gum in different styles" >
Render some emojis with `:emoji:` syntax with `gum format -t emoji` .
2022-07-15 18:01:19 +03:00
```bash
echo 'I :heart: Bubble Gum :candy:' | gum format -t emoji
```
2022-07-15 18:14:38 +03:00
< img src = "https://stuff.charm.sh/gum/format-emoji.png" width = "400" alt = "Format emoji command displaying I :heart: Bubble Gum :candy:." >
2022-07-11 20:30:57 +03:00
## Examples
See the [examples ](./examples/ ) directory for more real world use cases.
How to use `gum` in your daily workflows:
#### Write a commit message
Prompt for user input to write git commit messages with a short summary and
longer details with `gum input` and `gum write` .
Bonus points if you use `gum filter` with the [Conventional Commits
Specification](https://www.conventionalcommits.org/en/v1.0.0/#summary) as a
prefix for your commit message.
```bash
git commit -m "$(gum input --width 50 --placeholder "Summary of changes")" \
-m "$(gum write --width 80 --placeholder "Details of changes")"
```
2022-07-13 23:26:58 +03:00
< img src = "https://stuff.charm.sh/gum/commit.gif" width = "600" alt = "Running the ./examples/commit.sh script to commit to git" >
#### Open files in your `$EDITOR`
By default `gum filter` will display a list of all files (searched recursively)
through your current directory, it has some sensible ignored defaults (`.git`,
`node_modules` ). You can use this to pick a file and open it in your `$EDITOR` .
```bash
$EDITOR $(gum filter)
```
2022-07-11 20:30:57 +03:00
#### Connect to a TMUX session
Pick from a running `TMUX` session and attach to it if not inside `TMUX` or
switch your client to the session if already attached to a session.
```bash
SESSION=$(tmux list-sessions -F \#S | gum filter --placeholder "Pick session...")
tmux switch-client -t $SESSION || tmux attach -t $SESSION
```
2022-07-08 06:21:31 +03:00
2022-07-11 20:54:45 +03:00
#### Pick commit hash from history
Filter through your git history searching for commit messages and copy the
commit hash of the selected commit.
```bash
git log --oneline | gum filter | cut -d' ' -f1 # | copy
```
2022-07-13 20:14:59 +03:00
#### Choose packages to uninstall
List all packages installed by your package manager (we'll use `brew` ) and
choose which packages to uninstall.
```bash
brew list | gum choose --no-limit | xargs brew uninstall
```
2022-07-11 20:54:45 +03:00
2022-06-11 01:07:40 +03:00
## Feedback
We’ d love to hear your thoughts on this project. Feel free to drop us a note!
* [Twitter ](https://twitter.com/charmcli )
* [The Fediverse ](https://mastodon.technology/@charm )
* [Slack ](https://charm.sh/slack )
## License
2022-07-11 20:30:57 +03:00
[MIT ](https://github.com/charmbracelet/gum/raw/main/LICENSE )
2022-06-11 01:07:40 +03:00
Part of [Charm ](https://charm.sh ).
< a href = "https://charm.sh/" > < img alt = "The Charm logo" src = "https://stuff.charm.sh/charm-badge.jpg" width = "400" > < / a >
Charm热爱开源 • Charm loves open source