deblan-mirror/gum
deblan-mirror/gum
1
0
Fork 0
mirror of https://github.com/charmbracelet/gum synced 2024-05-17 21:56:42 +02:00
Code Issues Packages Projects Releases Wiki Activity
4 commits 6 branches 14 tags 1.4 MiB
Go 99.3%
Nix 0.6%
Go to file
Maas Lalani 454040cf4d
feat: Add gum spin command 
Spin provides a shell script interface for the spinner bubble. It is
useful for displaying that some task is running in the background while
consuming it's output so that it is not shown to the user.

For example, let's do a long running task:
```
sleep 5
```

We can simply prepend a spinner to this task to show it to the user,
while performing the task / command in the background.

```
gum spin -t "Taking a nap..." -- sleep 5
```

The spinner will automatically exit when the task is complete.
2022-07-07 13:29:10 -04:00
input feat: Add gum input command 2022-07-07 13:28:52 -04:00
search feat: Add gum search command 2022-07-07 13:29:10 -04:00
spin feat: Add gum spin command 2022-07-07 13:29:10 -04:00
.gitignore Initial commit 2022-07-06 12:05:45 -04:00
go.mod Initial commit 2022-07-06 12:05:45 -04:00
go.sum Initial commit 2022-07-06 12:05:45 -04:00
LICENSE Initial commit 2022-07-06 12:05:45 -04:00
main.go Initial commit 2022-07-06 12:05:45 -04:00
pop.go Initial commit 2022-07-06 12:05:45 -04:00
README.md Initial commit 2022-07-06 12:05:45 -04:00

README.md

Soda Pop

Command line utilities to make your command-line pop.

Soda Pop provides utilities to help you create shell scripts make your user's shells pop. Powered by Bubbles and Lip Gloss

Interaction

Input

Prompt your users for input with a simple command.

pop input > answer.text

Search

Allow your users to filter through a list of options by fuzzy searching.

echo Gastropoda >> options.text
echo Bivalvia >> options.text
echo Polyplacophora >> options.text
cat options.text | pop search > selection.text

Loading

Display a progress bar while loading.

pop loading --time 5s

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.

pop spin --spinner dot --title "Buying Soda Pop..." -- sleep 5

⣽ Buying Soda Pop...

Styling

Pretty print any string with any layout with one command.

pop style \
    --foreground "#FF06B7" --border "double" \
    --margin 2 --padding "2 4" --width 50 \
    "And oh gosh, how delicious the fabulous frizzy frobscottle was!

Result:

╔══════════════════════════════════════════════════╗
║                                                  ║
║                                                  ║
║    And oh gosh, how delicious the fabulous       ║
║    frizzy frobscottle was!                       ║
║                                                  ║
║                                                  ║
╚══════════════════════════════════════════════════╝

Feedback

We’d love to hear your thoughts on this project. Feel free to drop us a note!

License

MIT

Part of Charm.

The Charm logo

Charm热爱开源 • Charm loves open source