mirror of
https://github.com/charmbracelet/gum
synced 2024-06-04 23:02:16 +02:00
docs: customization flags
This commit is contained in:
parent
9b2e4add3e
commit
74ef277486
22
README.md
22
README.md
|
@ -6,11 +6,12 @@
|
||||||
<a href="https://github.com/charmbracelet/gum/actions"><img src="https://github.com/charmbracelet/gum/workflows/build/badge.svg" alt="Build Status"></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>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
Gum is a collection of command-line utilities that make your shell scripts a
|
Gum is a collection of command-line utilities that make your shell scripts a
|
||||||
little more glamorous. It gives you the power of
|
little more glamorous. It gives you the power of
|
||||||
[Bubbles](https://github.com/charmbracelet/bubbles) and
|
[Bubbles](https://github.com/charmbracelet/bubbles) and [Lip
|
||||||
[Lip Gloss](https://github.com/charmbracelet/lipgloss) without needing to write
|
Gloss](https://github.com/charmbracelet/lipgloss) without needing to write any
|
||||||
any Go code.
|
Go code.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Prompt users for input
|
# Prompt users for input
|
||||||
|
@ -73,6 +74,21 @@ go install github.com/charmbracelet/gum@latest
|
||||||
|
|
||||||
[releases]: https://github.com/charmbracelet/gum/releases
|
[releases]: https://github.com/charmbracelet/gum/releases
|
||||||
|
|
||||||
|
## Customization
|
||||||
|
|
||||||
|
`gum` is designed to be embedded in scripts and different use cases. All
|
||||||
|
components are configurable and customizable to fit your theme and use case.
|
||||||
|
|
||||||
|
You can customize with `--flags`. See `gum <command> --help` for a full view of
|
||||||
|
all the command's customization and configuration options.
|
||||||
|
|
||||||
|
For example, let's customize the cursor color, prompt color, prompt indicator,
|
||||||
|
placeholder text, width, and pre-populate the value of the input:
|
||||||
|
```bash
|
||||||
|
gum input --cursor.foreground "#FF0" --prompt.foreground "#0FF" --prompt "* " \
|
||||||
|
--placeholder "What's up?" --width 80 --value "Not much, hby?"
|
||||||
|
```
|
||||||
|
|
||||||
## Interaction
|
## Interaction
|
||||||
|
|
||||||
#### Input
|
#### Input
|
||||||
|
|
Loading…
Reference in a new issue