Quickstart
Welcome to rooibos! This guide will help you get up and running with your first Terminal User Interface in Ruby.
Installation
See Installation in the README for setup instructions.
Tutorials
Basic Application
Here is a “Hello World” application that demonstrates the core lifecycle of a rooibos app.
_Because this gem is in pre-release, it lacks documentation. Please check the source files.
How it works
_Because this gem is in pre-release, it lacks documentation. Please check the source files.
Examples
These examples showcase the full power of rooibos. You can find their source code in the examples directory.
Widget Demos
Focused examples for individual concepts. Each demonstrates a single concept and ways to interact with it.
| Widget | What it demonstrates |
|---|---|
| Automated Tests | Because this gem is in pre-release, it lacks documentation. Please check the automated tests for details. |
Sample Applications
These larger examples combine concepts into complete applications, demonstrating real-world TUI patterns and architectures.
| Application | Architecture | What you’ll learn |
|---|---|---|
| Automated Tests | Because this gem is in pre-release, it lacks documentation. Please check the automated tests for details. |
Next Steps
Now that you’ve seen what rooibos can do:
-
Deep dive: Read the Application Architecture guide for scaling patterns
-
Test your TUI: See the Testing Guide for snapshot and style assertions
-
Avoid common mistakes: See Terminal Output During TUI Sessions to prevent screen corruption
-
Explore the API: Browse the full documentation
-
Learn the philosophy: Read Why RatatuiRuby? for comparisons and design decisions
-
Get help: Join the discussion mailing list