2022-07-16 00:26:33 +03:00
|
|
|
|
Gum
|
|
|
|
|
===
|
2022-06-11 01:07:40 +03:00
|
|
|
|
|
2022-07-08 20:47:21 +03:00
|
|
|
|
<p>
|
2022-07-27 04:48:56 +03:00
|
|
|
|
<a href="https://stuff.charm.sh/gum/nutritional-information.png" target="_blank"><img src="https://stuff.charm.sh/gum/gum.png" alt="Gum Image" width="450" /></a>
|
2022-07-18 20:57:54 +03:00
|
|
|
|
<br><br>
|
2022-07-08 20:47:21 +03:00
|
|
|
|
<a href="https://github.com/charmbracelet/gum/releases"><img src="https://img.shields.io/github/release/charmbracelet/gum.svg" alt="Latest Release"></a>
|
2022-07-28 15:52:44 +03:00
|
|
|
|
<a href="https://pkg.go.dev/github.com/charmbracelet/gum?tab=doc"><img src="https://godoc.org/github.com/golang/gddo?status.svg" alt="Go Docs"></a>
|
2022-07-08 20:47:21 +03:00
|
|
|
|
<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-28 00:00:38 +03:00
|
|
|
|
A tool for glamorous shell scripts. Leverage the power of
|
2022-07-27 01:33:42 +03:00
|
|
|
|
[Bubbles](https://github.com/charmbracelet/bubbles) and [Lip
|
2022-07-28 00:00:38 +03:00
|
|
|
|
Gloss](https://github.com/charmbracelet/lipgloss) in your scripts and aliases
|
|
|
|
|
without writing any Go code!
|
2022-07-15 23:11:32 +03:00
|
|
|
|
|
2022-10-25 02:05:37 +03:00
|
|
|
|
<img alt="Shell running the ./demo.sh script" width="600" src="https://stuff.charm.sh/gum/demo.gif">
|
2022-07-18 21:44:48 +03:00
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
The above example is running from a single shell script ([source](./examples/demo.sh)).
|
2022-07-26 18:01:11 +03:00
|
|
|
|
|
2022-07-21 18:55:52 +03:00
|
|
|
|
## Tutorial
|
|
|
|
|
|
2022-07-25 19:44:40 +03:00
|
|
|
|
Gum provides highly configurable, ready-to-use utilities to help you write
|
2022-07-28 23:24:41 +03:00
|
|
|
|
useful shell scripts and dotfiles aliases with just a few lines of code.
|
2022-07-22 22:57:56 +03:00
|
|
|
|
|
|
|
|
|
Let's build a simple script to help you write [Conventional
|
2022-07-21 18:55:52 +03:00
|
|
|
|
Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) for your
|
|
|
|
|
dotfiles.
|
|
|
|
|
|
2022-07-29 19:54:30 +03:00
|
|
|
|
Start with a `#!/bin/sh`.
|
2022-07-21 18:55:52 +03:00
|
|
|
|
```bash
|
2022-07-29 19:54:30 +03:00
|
|
|
|
#!/bin/sh
|
2022-07-21 18:55:52 +03:00
|
|
|
|
```
|
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
Ask for the commit type with `gum choose`:
|
2022-07-21 18:55:52 +03:00
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
gum choose "fix" "feat" "docs" "style" "refactor" "test" "chore" "revert"
|
|
|
|
|
```
|
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
> Tip: this command itself will print to `stdout` which is not all that useful.
|
|
|
|
|
To make use of the command later on you can save the stdout to a `$VARIABLE` or
|
|
|
|
|
`file.txt`.
|
2022-07-21 18:55:52 +03:00
|
|
|
|
|
|
|
|
|
Prompt for an (optional) scope for the commit:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
gum input --placeholder "scope"
|
|
|
|
|
```
|
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
Prompt for a commit message:
|
2022-07-21 18:55:52 +03:00
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
gum input --placeholder "Summary of this change"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Prompt for a detailed (multi-line) explanation of the changes:
|
|
|
|
|
|
|
|
|
|
```bash
|
2022-08-05 15:48:31 +03:00
|
|
|
|
gum write --placeholder "Details of this change (CTRL+D to finish)"
|
2022-07-21 18:55:52 +03:00
|
|
|
|
```
|
|
|
|
|
|
2022-07-28 01:40:52 +03:00
|
|
|
|
Prompt for a confirmation before committing:
|
2022-07-28 01:45:59 +03:00
|
|
|
|
> `gum confirm` exits with status `0` if confirmed and status `1` if cancelled.
|
2022-07-28 01:40:52 +03:00
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
gum confirm "Commit changes?" && git commit -m "$SUMMARY" -m "$DESCRIPTION"
|
|
|
|
|
```
|
|
|
|
|
|
2022-07-21 18:55:52 +03:00
|
|
|
|
Putting it all together...
|
|
|
|
|
|
|
|
|
|
```bash
|
2022-07-29 19:54:30 +03:00
|
|
|
|
#!/bin/sh
|
2022-07-21 18:55:52 +03:00
|
|
|
|
TYPE=$(gum choose "fix" "feat" "docs" "style" "refactor" "test" "chore" "revert")
|
|
|
|
|
SCOPE=$(gum input --placeholder "scope")
|
|
|
|
|
|
|
|
|
|
# Since the scope is optional, wrap it in parentheses if it has a value.
|
2022-07-29 19:54:30 +03:00
|
|
|
|
test -n "$SCOPE" && SCOPE="($SCOPE)"
|
2022-07-21 18:55:52 +03:00
|
|
|
|
|
|
|
|
|
# Pre-populate the input with the type(scope): so that the user may change it
|
|
|
|
|
SUMMARY=$(gum input --value "$TYPE$SCOPE: " --placeholder "Summary of this change")
|
2022-08-05 15:48:31 +03:00
|
|
|
|
DESCRIPTION=$(gum write --placeholder "Details of this change (CTRL+D to finish)")
|
2022-07-21 18:55:52 +03:00
|
|
|
|
|
|
|
|
|
# Commit these changes
|
2022-07-28 01:40:52 +03:00
|
|
|
|
gum confirm "Commit changes?" && git commit -m "$SUMMARY" -m "$DESCRIPTION"
|
2022-07-21 18:55:52 +03:00
|
|
|
|
```
|
|
|
|
|
|
2022-10-25 02:05:37 +03:00
|
|
|
|
<img alt="Running the ./examples/commit.sh script to commit to git" width="600" src="https://stuff.charm.sh/gum/commit_2.gif">
|
2022-07-21 18:55:52 +03:00
|
|
|
|
|
2022-07-08 20:31:54 +03:00
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
Use a package manager:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# macOS or Linux
|
2022-07-31 18:49:38 +03:00
|
|
|
|
brew install gum
|
2022-07-08 20:31:54 +03:00
|
|
|
|
|
2022-07-09 00:34:51 +03:00
|
|
|
|
# Arch Linux (btw)
|
2022-08-04 18:51:05 +03:00
|
|
|
|
pacman -S gum
|
2022-07-08 20:31:54 +03:00
|
|
|
|
|
|
|
|
|
# Nix
|
|
|
|
|
nix-env -iA nixpkgs.gum
|
2022-10-13 18:00:04 +03:00
|
|
|
|
# Or, with flakes
|
|
|
|
|
nix run "github:charmbracelet/gum" -- --help
|
2022-07-26 01:16:13 +03:00
|
|
|
|
|
|
|
|
|
# Debian/Ubuntu
|
2022-10-17 23:31:09 +03:00
|
|
|
|
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
|
2022-07-26 01:16:13 +03:00
|
|
|
|
sudo apt update && sudo apt install gum
|
|
|
|
|
|
2022-10-17 23:31:09 +03:00
|
|
|
|
# Fedora/RHEL
|
2022-07-26 01:16:13 +03:00
|
|
|
|
echo '[charm]
|
|
|
|
|
name=Charm
|
|
|
|
|
baseurl=https://repo.charm.sh/yum/
|
|
|
|
|
enabled=1
|
2022-10-07 00:30:43 +03:00
|
|
|
|
gpgcheck=1
|
|
|
|
|
gpgkey=https://repo.charm.sh/yum/gpg.key' | sudo tee /etc/yum.repos.d/charm.repo
|
2022-07-26 01:16:13 +03:00
|
|
|
|
sudo yum install gum
|
2022-10-23 05:28:41 +03:00
|
|
|
|
|
|
|
|
|
# Alpine
|
|
|
|
|
apk add gum
|
|
|
|
|
|
|
|
|
|
# Android (via termux)
|
|
|
|
|
pkg install gum
|
2022-07-08 20:31:54 +03:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Or download it:
|
|
|
|
|
|
2022-10-23 06:04:16 +03:00
|
|
|
|
* [Packages][releases] are available in Debian, RPM, and Alpine formats
|
|
|
|
|
* [Binaries][releases] are available for Linux, macOS, Windows, FreeBSD, OpenBSD, and NetBSD
|
2022-07-08 20:31:54 +03:00
|
|
|
|
|
|
|
|
|
Or just install it with `go`:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
go install github.com/charmbracelet/gum@latest
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
[releases]: https://github.com/charmbracelet/gum/releases
|
|
|
|
|
|
2022-07-15 23:11:32 +03:00
|
|
|
|
## Customization
|
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
`gum` is designed to be embedded in scripts and supports all sorts of use
|
|
|
|
|
cases. Components are configurable and customizable to fit your theme and
|
|
|
|
|
use case.
|
2022-07-15 23:11:32 +03:00
|
|
|
|
|
|
|
|
|
You can customize with `--flags`. See `gum <command> --help` for a full view of
|
2022-07-26 20:21:08 +03:00
|
|
|
|
each command's customization and configuration options.
|
|
|
|
|
|
|
|
|
|
For example, let's use an `input` and change the cursor color, prompt color,
|
|
|
|
|
prompt indicator, placeholder text, width, and pre-populate the value:
|
2022-07-15 23:11:32 +03:00
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
gum input --cursor.foreground "#FF0" --prompt.foreground "#0FF" --prompt "* " \
|
|
|
|
|
--placeholder "What's up?" --width 80 --value "Not much, hby?"
|
|
|
|
|
```
|
|
|
|
|
|
2022-08-09 00:06:30 +03:00
|
|
|
|
You can also use `ENVIRONMENT_VARIABLES` to customize `gum` by default, this is
|
|
|
|
|
useful to keep a consistent theme for all your `gum` commands.
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
# Uses values configured through environment variables above but can still be
|
|
|
|
|
# overridden with flags.
|
|
|
|
|
gum input
|
|
|
|
|
```
|
|
|
|
|
|
2022-10-25 02:05:37 +03:00
|
|
|
|
<img alt="Gum input displaying most customization options" width="600" src="https://stuff.charm.sh/gum/customization.gif">
|
2022-07-22 19:00:38 +03:00
|
|
|
|
|
2022-06-11 01:07:40 +03:00
|
|
|
|
## Interaction
|
|
|
|
|
|
|
|
|
|
#### Input
|
2022-07-26 20:21:08 +03:00
|
|
|
|
|
|
|
|
|
Prompt for input with a simple command.
|
2022-06-11 01:07:40 +03:00
|
|
|
|
|
|
|
|
|
```bash
|
2022-10-08 14:54:41 +03:00
|
|
|
|
gum input > answer.txt
|
2022-06-11 01:07:40 +03:00
|
|
|
|
```
|
|
|
|
|
|
2022-08-03 03:54:16 +03:00
|
|
|
|
Prompt for sensitive input with the `--password` flag.
|
|
|
|
|
|
|
|
|
|
```bash
|
2022-10-08 14:54:41 +03:00
|
|
|
|
gum input --password > password.txt
|
2022-08-03 03:54:16 +03:00
|
|
|
|
```
|
|
|
|
|
|
2022-10-25 02:05:37 +03:00
|
|
|
|
<img src="https://stuff.charm.sh/gum/input_1.gif" width="600" alt="Shell running gum input typing Not much, you?" />
|
2022-07-13 06:44:06 +03:00
|
|
|
|
|
2022-07-08 06:21:31 +03:00
|
|
|
|
#### Write
|
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
Prompt for some multi-line text.
|
2022-07-08 06:21:31 +03:00
|
|
|
|
|
2022-09-07 11:59:08 +03:00
|
|
|
|
Note: `CTRL+D` and `esc` are used to complete text entry. `CTRL+C` will cancel.
|
2022-08-05 15:48:31 +03:00
|
|
|
|
|
2022-07-08 06:21:31 +03:00
|
|
|
|
```bash
|
2022-10-08 14:54:41 +03:00
|
|
|
|
gum write > story.txt
|
2022-07-08 06:21:31 +03:00
|
|
|
|
```
|
|
|
|
|
|
2022-10-25 02:05:37 +03:00
|
|
|
|
<img src="https://stuff.charm.sh/gum/write.gif" width="600" alt="Shell running gum write typing a story" />
|
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
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
Use fuzzy matching to filter a list of values:
|
2022-06-11 01:07:40 +03:00
|
|
|
|
|
|
|
|
|
```bash
|
2022-10-08 14:54:41 +03:00
|
|
|
|
echo Strawberry >> flavors.txt
|
|
|
|
|
echo Banana >> flavors.txt
|
|
|
|
|
echo Cherry >> flavors.txt
|
|
|
|
|
cat flavors.txt | gum filter > selection.txt
|
2022-06-11 01:07:40 +03:00
|
|
|
|
```
|
|
|
|
|
|
2022-10-25 02:05: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
|
|
|
|
|
2022-09-30 20:34:21 +03:00
|
|
|
|
You can also select multiple items with the `--limit` flag, which determines
|
|
|
|
|
the maximum number of items that can be chosen.
|
|
|
|
|
|
|
|
|
|
```bash
|
2022-10-08 14:54:41 +03:00
|
|
|
|
cat flavors.txt | gum filter --limit 2
|
2022-09-30 20:34:21 +03:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Or, allow any number of selections with the `--no-limit` flag.
|
|
|
|
|
|
|
|
|
|
```bash
|
2022-10-08 14:54:41 +03:00
|
|
|
|
cat flavors.txt | gum filter --no-limit
|
2022-09-30 20:34:21 +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
|
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
Choose an option from a list of choices.
|
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
|
|
|
|
|
|
|
|
|
```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-26 20:21:08 +03:00
|
|
|
|
You can also select multiple items with the `--limit` flag, which determines
|
|
|
|
|
the maximum of items that can be chosen.
|
2022-07-13 20:14:59 +03:00
|
|
|
|
|
|
|
|
|
```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-10-25 02:05:37 +03:00
|
|
|
|
<img src="https://stuff.charm.sh/gum/choose.gif" width="600" alt="Shell running gum choose with numbers and gum flavors" />
|
2022-07-13 06:44:06 +03:00
|
|
|
|
|
2022-07-26 23:09:33 +03:00
|
|
|
|
#### Confirm
|
|
|
|
|
|
|
|
|
|
Confirm whether to perform an action. Exits with code `0` (affirmative) or `1`
|
|
|
|
|
(negative) depending on selection.
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
gum confirm && rm file.txt || echo "File not removed"
|
|
|
|
|
```
|
|
|
|
|
|
2022-10-25 02:05:37 +03:00
|
|
|
|
<img src="https://stuff.charm.sh/gum/confirm_2.gif" width="600" alt="Shell running gum confirm" />
|
2022-07-26 23:09:33 +03:00
|
|
|
|
|
2022-10-02 22:55:14 +03:00
|
|
|
|
#### File
|
|
|
|
|
|
|
|
|
|
Prompt the user to select a file from the file tree.
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
EDITOR $(gum file $HOME)
|
|
|
|
|
```
|
|
|
|
|
|
2022-10-25 02:05:37 +03:00
|
|
|
|
<img src="https://stuff.charm.sh/gum/file.gif" width="600" alt="Shell running gum file" />
|
2022-10-02 22:55:14 +03:00
|
|
|
|
|
|
|
|
|
#### Pager
|
|
|
|
|
|
|
|
|
|
Scroll through a long document with line numbers and a fully customizable viewport.
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
gum pager < README.md
|
|
|
|
|
```
|
|
|
|
|
|
2022-10-25 02:05:37 +03:00
|
|
|
|
<img src="https://stuff.charm.sh/gum/pager.gif" width="600" alt="Shell running gum pager" />
|
2022-10-02 22:55:14 +03:00
|
|
|
|
|
2022-07-18 21:44:48 +03:00
|
|
|
|
#### Spin
|
2022-06-11 01:07:40 +03:00
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
Display a spinner while running a script or command. The spinner will
|
|
|
|
|
automatically stop after the given command exits.
|
2022-06-11 01:07:40 +03:00
|
|
|
|
|
|
|
|
|
```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-10-25 02:05:37 +03:00
|
|
|
|
<img src="https://stuff.charm.sh/gum/spin.gif" width="600" alt="Shell running gum spin while sleeping for 5 seconds" />
|
2022-07-13 06:44:06 +03:00
|
|
|
|
|
2022-07-30 23:56:22 +03:00
|
|
|
|
Available spinner types include: `line`, `dot`, `minidot`, `jump`, `pulse`, `points`, `globe`, `moon`, `monkey`, `meter`, `hamburger`.
|
2022-07-30 23:53:24 +03:00
|
|
|
|
|
2022-10-02 22:55:14 +03:00
|
|
|
|
#### Table
|
|
|
|
|
|
|
|
|
|
Select a row from some tabular data.
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
gum table < flavors.csv | cut -d ',' -f 1
|
|
|
|
|
```
|
|
|
|
|
|
2022-10-25 02:05:37 +03:00
|
|
|
|
<img src="https://stuff.charm.sh/gum/table.gif" width="600" alt="Shell running gum table" />
|
2022-10-02 22:55:14 +03:00
|
|
|
|
|
2022-07-18 21:44:48 +03:00
|
|
|
|
## Styling
|
2022-06-11 01:07:40 +03:00
|
|
|
|
|
2022-07-08 06:21:31 +03:00
|
|
|
|
#### Style
|
2022-07-18 21:44:48 +03:00
|
|
|
|
|
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-10-25 02:05:37 +03:00
|
|
|
|
<img src="https://stuff.charm.sh/gum/style.gif" width="600" alt="Bubble Gum, So sweet and so fresh!" />
|
2022-06-11 01:07:40 +03:00
|
|
|
|
|
2022-07-18 21:44:48 +03:00
|
|
|
|
## Layout
|
|
|
|
|
|
2022-07-08 06:21:31 +03:00
|
|
|
|
#### Join
|
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
Combine text vertically or horizontally. Use this command with `gum style` to
|
|
|
|
|
build layouts and pretty output.
|
2022-07-08 06:21:31 +03:00
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
Tip: Always wrap the output of `gum style` in quotes to preserve newlines
|
|
|
|
|
(`\n`) when using it as an argument in the `join` command.
|
2022-07-08 06:21:31 +03:00
|
|
|
|
|
|
|
|
|
```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-10-25 02:05:37 +03:00
|
|
|
|
<img src="https://stuff.charm.sh/gum/join.gif" 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-18 21:44:48 +03:00
|
|
|
|
## Format
|
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
`format` processes and formats bodies of text. `gum format` can parse markdown,
|
|
|
|
|
template strings, and named emojis.
|
2022-07-15 18:01:19 +03:00
|
|
|
|
|
|
|
|
|
```bash
|
2022-07-20 20:49:09 +03:00
|
|
|
|
# Format some markdown
|
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-20 20:49:09 +03:00
|
|
|
|
# Syntax highlight some code
|
2022-07-15 18:01:19 +03:00
|
|
|
|
cat main.go | gum format -t code
|
2022-07-18 21:44:48 +03:00
|
|
|
|
|
2022-07-20 20:49:09 +03:00
|
|
|
|
# Render text any way you want with templates
|
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-20 20:49:09 +03:00
|
|
|
|
# Display your favorite emojis!
|
2022-07-15 18:01:19 +03:00
|
|
|
|
echo 'I :heart: Bubble Gum :candy:' | gum format -t emoji
|
|
|
|
|
```
|
|
|
|
|
|
2022-07-29 19:51:44 +03:00
|
|
|
|
For more information on template helpers, see the [Termenv
|
2022-07-26 20:21:08 +03:00
|
|
|
|
docs](https://github.com/muesli/termenv#template-helpers). For a full list of
|
|
|
|
|
named emojis see the [GitHub API](https://api.github.com/emojis).
|
|
|
|
|
|
2022-10-25 02:05:37 +03:00
|
|
|
|
<img src="https://stuff.charm.sh/gum/format.gif" width="600" alt="Running gum format for different types of formats" />
|
2022-07-15 18:14:38 +03:00
|
|
|
|
|
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
|
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
Prompt for input to write git commit messages with a short summary and
|
2022-07-11 20:30:57 +03:00
|
|
|
|
longer details with `gum input` and `gum write`.
|
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
Bonus points: use `gum filter` with the [Conventional Commits
|
2022-07-11 20:30:57 +03:00
|
|
|
|
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")" \
|
2022-08-05 15:48:31 +03:00
|
|
|
|
-m "$(gum write --width 80 --placeholder "Details of changes (CTRL+D to finish)")"
|
2022-07-11 20:30:57 +03:00
|
|
|
|
```
|
|
|
|
|
|
2022-07-13 23:26:58 +03:00
|
|
|
|
#### Open files in your `$EDITOR`
|
|
|
|
|
|
2022-07-28 00:00:38 +03:00
|
|
|
|
By default, `gum filter` will display a list of all files (searched
|
|
|
|
|
recursively) through your current directory, with some sensible ignore settings
|
|
|
|
|
(`.git`, `node_modules`). You can use this command to easily to pick a file and
|
|
|
|
|
open it in your `$EDITOR`.
|
2022-07-13 23:26:58 +03:00
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
$EDITOR $(gum filter)
|
|
|
|
|
```
|
|
|
|
|
|
2022-07-11 20:30:57 +03:00
|
|
|
|
#### Connect to a TMUX session
|
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
Pick from a running `tmux` session and attach to it. Or, if you're already in a
|
|
|
|
|
`tmux` session, switch sessions.
|
2022-07-11 20:30:57 +03:00
|
|
|
|
|
|
|
|
|
```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-10-25 02:05:37 +03:00
|
|
|
|
<img src="https://stuff.charm.sh/gum/pick-tmux-session.gif" width="600" alt="Picking a tmux session with gum filter" />
|
2022-07-15 18:23:21 +03:00
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
#### Pick commit hash from your Git history
|
2022-07-11 20:54:45 +03:00
|
|
|
|
|
2022-07-26 20:21:08 +03:00
|
|
|
|
Filter through your git history searching for commit messages, copying the
|
|
|
|
|
commit hash of the commit you select.
|
2022-07-11 20:54:45 +03:00
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git log --oneline | gum filter | cut -d' ' -f1 # | copy
|
|
|
|
|
```
|
|
|
|
|
|
2022-10-25 02:05:37 +03:00
|
|
|
|
<img src="https://stuff.charm.sh/gum/pick-commit.gif" width="600" alt="Picking a commit with gum filter" />
|
2022-07-15 18:23:21 +03:00
|
|
|
|
|
2022-08-30 19:24:11 +03:00
|
|
|
|
#### Skate Passwords
|
|
|
|
|
|
|
|
|
|
Build a simple (encrypted) password selector with [Skate](https://github.com/charmbracelet/skate).
|
|
|
|
|
|
|
|
|
|
Save all your passwords to [Skate](https://github.com/charmbracelet/skate) with `skate set github@pass.db PASSWORD`, etc...
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
skate list -k | gum filter | xargs skate get
|
|
|
|
|
```
|
|
|
|
|
|
2022-10-25 02:05:37 +03:00
|
|
|
|
<img src="https://stuff.charm.sh/gum/skate-pass.gif" width="600" alt="Selecting a skate value with gum" />
|
2022-08-30 19:24:11 +03:00
|
|
|
|
|
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-07-31 05:02:07 +03:00
|
|
|
|
#### Choose branches to delete
|
|
|
|
|
|
|
|
|
|
List all branches and choose which branches to delete.
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git branch | cut -c 3- | gum choose --no-limit | xargs git branch -D
|
|
|
|
|
```
|
|
|
|
|
|
2022-08-01 23:09:45 +03:00
|
|
|
|
#### Choose pull request to checkout
|
|
|
|
|
|
|
|
|
|
List all PRs for the current GitHub repository and checkout the chosen PR (using [`gh`](https://cli.github.com/)).
|
|
|
|
|
|
|
|
|
|
```bash
|
2022-08-02 18:26:44 +03:00
|
|
|
|
gh pr list | cut -f1,2 | gum choose | cut -f1 | xargs gh pr checkout
|
2022-08-01 23:09:45 +03:00
|
|
|
|
```
|
|
|
|
|
|
2022-08-05 00:53:53 +03:00
|
|
|
|
#### Pick command from shell history
|
|
|
|
|
|
|
|
|
|
Pick a previously executed command from your shell history to execute, copy,
|
|
|
|
|
edit, etc...
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
gum filter < $HISTFILE --height 20
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
#### Sudo password input
|
|
|
|
|
|
|
|
|
|
See visual feedback when entering password with masked characters with `gum
|
|
|
|
|
input --password`.
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
alias please="gum input --password | sudo -nS"
|
|
|
|
|
```
|
|
|
|
|
|
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)
|
2022-10-24 09:36:19 +03:00
|
|
|
|
* [The Fediverse](https://mastodon.social/@charmcli)
|
|
|
|
|
* [Discord](https://charm.sh/chat)
|
2022-06-11 01:07:40 +03:00
|
|
|
|
|
|
|
|
|
## 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
|
|
|
|
|
2022-10-24 09:36:19 +03:00
|
|
|
|
***
|
2022-07-27 02:29:07 +03:00
|
|
|
|
|
2022-06-11 01:07:40 +03:00
|
|
|
|
Part of [Charm](https://charm.sh).
|
|
|
|
|
|
2022-07-20 22:19:23 +03:00
|
|
|
|
<a href="https://charm.sh/"><img alt="The Charm logo" src="https://stuff.charm.sh/charm-badge.jpg" width="400" /></a>
|
2022-06-11 01:07:40 +03:00
|
|
|
|
|
|
|
|
|
Charm热爱开源 • Charm loves open source
|