gum
A tool for glamorous shell scripts π
File Explorer
Download Latest Version (.zip)- build.yml
- dependabot-sync.yml
- goreleaser.yml
- lint-sync.yml
- lint.yml
- nightly.yml
- dependabot.yml
- pull_request_template.md
- choose.go
- command.go
- options.go
- bash.go
- command.go
- fish.go
- zsh.go
- command.go
- confirm.go
- options.go
- cursor.go
- .gitignore
- choose.tape
- commit.sh
- commit.tape
- confirm.tape
- convert-to-gif.sh
- customize.tape
- demo.sh
- demo.tape
- diyfetch
- fav.txt
- file.tape
- filter-key-value.sh
- flavors.txt
- format.ansi
- git-branch-manager.sh
- git-stage.sh
- gum.js
- gum.py
- gum.rb
- input.tape
- kaomoji.sh
- magic.sh
- pager.tape
- posix.sh
- README.md
- skate.sh
- spin.tape
- story.txt
- test.sh
- write.tape
- command.go
- file.go
- options.go
- command.go
- filter.go
- filter_test.go
- options.go
- command.go
- formats.go
- options.go
- README.md
- command.go
- input.go
- options.go
- align.go
- exit.go
- files.go
- stdin.go
- context.go
- tty.go
- command.go
- options.go
- command.go
- options.go
- command.go
- command.go
- options.go
- pager.go
- search.go
- command.go
- options.go
- pty.go
- spin.go
- spinners.go
- ascii_a.txt
- borders.go
- command.go
- lipgloss.go
- options.go
- spacing.go
- bom.csv
- comma.csv
- command.go
- example.csv
- invalid.csv
- options.go
- table.go
- command.go
- options.go
- command.go
- options.go
- write.go
- .gitignore
- .golangci.yml
- .goreleaser.yml
- default.nix
- Dockerfile
- flake.lock
- flake.nix
- go.mod
- go.sum
- gum.go
- LICENSE
- main.go
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/charmbracelet/gum
Downloads the entire project code from GitHub to your computer.
cd gum
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
brew install gum
Installs the pre-built package via Homebrew β no source build required.
scoop install charm-gum
Installs directly via Scoop (Windows).
go install charm.land/gum/v2@latest
Downloads and installs the specified version directly β no need to clone the repo yourself.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t gum .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 gum
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
4. Go
MediumPrerequisites
go install charm.land/gum/v2@latest
Downloads and installs the specified version directly β no need to clone the repo yourself.
If the build finishes without errors, it worked. If you used go run ., check the terminal output.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)