2022-06-11 00:07:40 +02:00
|
|
|
|
# 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](https://github.com/charmbracelet/bubbles)
|
|
|
|
|
|
and [Lip Gloss](https://github.com/charmbracelet/lipgloss)
|
|
|
|
|
|
|
|
|
|
|
|
## Interaction
|
|
|
|
|
|
|
|
|
|
|
|
#### Input
|
|
|
|
|
|
Prompt your users for input with a simple command.
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
pop input > answer.text
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
#### Search
|
|
|
|
|
|
|
|
|
|
|
|
Allow your users to filter through a list of options by fuzzy searching.
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
2022-07-06 21:24:26 +02:00
|
|
|
|
echo Cherry >> flavors.text
|
|
|
|
|
|
echo Grape >> flavors.text
|
|
|
|
|
|
echo Lime >> flavors.text
|
|
|
|
|
|
echo Orange >> flavors.text
|
|
|
|
|
|
cat flavors.text | pop search > selection.text
|
2022-06-11 00:07:40 +02:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
#### Loading
|
|
|
|
|
|
|
|
|
|
|
|
Display a progress bar while loading.
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
pop spin --spinner dot --title "Buying Soda Pop..." -- sleep 5
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
⣽ Buying Soda Pop...
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Styling
|
|
|
|
|
|
|
|
|
|
|
|
Pretty print any string with any layout with one command.
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
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!
|
|
|
|
|
|
|
|
|
|
|
|
* [Twitter](https://twitter.com/charmcli)
|
|
|
|
|
|
* [The Fediverse](https://mastodon.technology/@charm)
|
|
|
|
|
|
* [Slack](https://charm.sh/slack)
|
|
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
|
|
[MIT](https://github.com/charmbracelet/seashell/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
|
