deblan-mirror/gum
deblan-mirror/gum
1
0
Fork 0
mirror of https://github.com/charmbracelet/gum synced 2024-05-15 20:56:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: customization flags

Browse source
This commit is contained in:
Maas Lalani 2022-07-15 16:11:32 -04:00
parent 9b2e4add3e
commit 74ef277486
No known key found for this signature in database
GPG key ID: 5A6ED5CBF1A0A000
1 changed files with 19 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -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>
</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.
[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
@ -73,6 +74,21 @@ go install github.com/charmbracelet/gum@latest
[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
#### Input