mirror of
https://github.com/charmbracelet/gum
synced 2024-06-27 09:40:06 +02:00
e72857b737
This commit adds usage examples to the README.md on how users can use gum in their workflows. In fact, this commit message is being created through the `gum write` command as shown in the example!
238 lines
7.1 KiB
Markdown
238 lines
7.1 KiB
Markdown
# Gum
|
||
|
||
<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>
|
||
|
||
Gum is a collection of command-line utilities that make your shell scripts a
|
||
little more glamorous. It gives you the power of
|
||
[Bubbles](https://github.com/charmbracelet/bubbles) and
|
||
[Lip Gloss](https://github.com/charmbracelet/lipgloss) without needing to write
|
||
any Go code.
|
||
|
||
```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
|
||
```
|
||
|
||
The following example is running from a [single Bash script](./examples/demo.sh).
|
||
|
||
<img src="https://stuff.charm.sh/gum/gum.gif" width="900" alt="Shell running the Gum examples/demo.sh script">
|
||
|
||
## Installation
|
||
|
||
Use a package manager:
|
||
|
||
```bash
|
||
# macOS or Linux
|
||
brew tap charmbracelet/tap && brew install charmbracelet/tap/gum
|
||
|
||
# Arch Linux (btw)
|
||
pacman -S gum
|
||
|
||
# Nix
|
||
nix-env -iA nixpkgs.gum
|
||
|
||
# Debian/Ubuntu
|
||
echo 'deb [trusted=yes] https://repo.charm.sh/apt/ /' \
|
||
| sudo tee /etc/apt/sources.list.d/charm.list
|
||
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
|
||
|
||
## Interaction
|
||
|
||
#### Input
|
||
Prompt your users for input with a simple command.
|
||
|
||
```bash
|
||
gum input > answer.text
|
||
```
|
||
|
||
#### Write
|
||
|
||
Prompt your users to write some multi-line text.
|
||
|
||
```bash
|
||
gum write > story.text
|
||
```
|
||
|
||
#### Filter
|
||
|
||
Allow your users to filter through a list of options by fuzzy searching.
|
||
|
||
```bash
|
||
echo Strawberry >> flavors.text
|
||
echo Banana >> flavors.text
|
||
echo Cherry >> flavors.text
|
||
cat flavors.text | gum filter > selection.text
|
||
```
|
||
|
||
#### Progress
|
||
|
||
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.
|
||
|
||
```bash
|
||
gum progress --increment 0.1 --interval 1s
|
||
```
|
||
|
||
#### 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
|
||
gum spin --spinner dot --title "Buying Bubble Gum..." -- sleep 5
|
||
```
|
||
|
||
## Styling and Layout
|
||
|
||
#### Style
|
||
Pretty print any string with any layout with one command.
|
||
|
||
```bash
|
||
gum style \
|
||
--foreground "#FF06B7" --border "double" --align "center" \
|
||
--width 50 --margin "1 2" --padding "2 4" \
|
||
"Bubble Gum (1¢)" "So sweet and so fresh\!"
|
||
```
|
||
|
||
```
|
||
|
||
╔══════════════════════════════════════════════════╗
|
||
║ ║
|
||
║ ║
|
||
║ Bubble Gum (1¢) ║
|
||
║ So sweet and so fresh! ║
|
||
║ ║
|
||
║ ║
|
||
╚══════════════════════════════════════════════════╝
|
||
|
||
```
|
||
|
||
#### 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
|
||
I=$(gum style --padding "1 5" --border double "I")
|
||
LOVE=$(gum style --padding "1 4" --border double "LOVE")
|
||
BUBBLE=$(gum style --padding "1 8" --border double "Bubble")
|
||
GUM=$(gum style --padding "1 5" --border double "Gum")
|
||
|
||
I_LOVE=$(gum join "$I" "$LOVE")
|
||
BUBBLE_GUM=$(gum join "$BUBBLE" "$GUM")
|
||
gum join --align center --vertical "$I_LOVE" "$BUBBLE_GUM"
|
||
```
|
||
|
||
```
|
||
╔═══════════╗╔════════════╗
|
||
║ ║║ ║
|
||
║ I ║║ LOVE ║
|
||
║ ║║ ║
|
||
╚═══════════╝╚════════════╝
|
||
╔══════════════════════╗╔═════════════╗
|
||
║ ║║ ║
|
||
║ Bubble ║║ Gum ║
|
||
║ ║║ ║
|
||
╚══════════════════════╝╚═════════════╝
|
||
```
|
||
|
||
## Examples
|
||
|
||
See the [examples](./examples/) directory for more real world use cases.
|
||
|
||
How to use `gum` in your daily workflows:
|
||
|
||
#### 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)
|
||
```
|
||
|
||
#### 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")"
|
||
```
|
||
|
||
#### 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
|
||
```
|
||
|
||
## 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
|
||
|
||
[MIT](https://github.com/charmbracelet/gum/raw/main/LICENSE)
|
||
|
||
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
|