bubbletea-ruby
A powerful TUI framework for Ruby, based on Charm's bubbletea.
File Explorer
Download Latest Version (.zip)- build-gems.yml
- main.yml
- console
- setup
- altscreen_toggle
- autocomplete
- cellbuffer
- chat
- composable_views
- confirm_quit
- countdown
- counter
- credit_card_form
- debounce
- exec
- eyes
- focus_blur
- fullscreen
- glamour
- help_demo
- http
- input
- list
- list_fancy
- mouse
- package_manager
- pager
- paginator
- pipe
- progress
- realtime
- resize
- result
- send_msg
- sequence
- simple
- spinner
- spinners
- split_editors
- stopwatch
- styled_list
- suspend
- table
- table_resize
- tabs
- terminal
- test_runner
- textarea_demo
- textinput
- textinputs
- timer
- tui_daemon_combo
- views
- window_title
- extconf.rb
- extension.c
- extension.h
- program.c
- bubbletea.go
- go.mod
- go.sum
- input.go
- keys.go
- renderer.go
- terminal.go
- commands.rb
- messages.rb
- model.rb
- runner.rb
- version.rb
- bubbletea.rb
- commands.rbs
- messages.rbs
- model.rbs
- runner.rbs
- version.rbs
- bubbletea.rbs
- bubbletea_test.rb
- messages_test.rb
- model_test.rb
- program_test.rb
- runner_test.rb
- test_helper.rb
- .gitignore
- .rubocop.yml
- .ruby-version
- bubbletea.gemspec
- CODE_OF_CONDUCT.md
- Gemfile
- Gemfile.lock
- LICENSE.txt
- Rakefile
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/marcoroth/bubbletea-ruby
Downloads the entire project code from GitHub to your computer.
cd bubbletea-ruby
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Ruby Ruby is required to use gem.
gem install bubbletea
Installs the package published on RubyGems directly.
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. Go
MediumPrerequisites
cd go
This project's files live in a subfolder, so move into it first.
go build ./...
Compiles the Go program into an executable.
go run .
Runs the Go program directly without a separate build step.
If the build finishes without errors, it worked. If you used go run ., check the terminal output.
4. Ruby
EasyPrerequisites
bundle install
Installs the Ruby libraries listed in the Gemfile.
bundle exec rake compile
Type this command into your terminal and run it.
bundle exec rake test
Type this command into your terminal and run it.
If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)