Cookbook

Practical recipes for building terminal applications with Raxol.

Guides

• Building Apps: TEA patterns, state machines, scrollable lists, key chords, testing
• Custom Components: author your own Components
• Configuration: TOML config, environment overrides
• SSH Deployment: Serve apps over SSH, production setup, Fly.io
• Theming: Terminal colors, theme system, LiveView CSS, accessibility
• LiveView Integration: Embed terminals in Phoenix LiveView
• Performance Optimization: 60fps rendering, diffing, caching

Examples

Complete applications are in the examples/ directory:

• examples/getting_started/counter.exs: Minimal TEA app
• examples/demo.exs: Live BEAM dashboard with sparklines
• examples/apps/file_browser.exs: File browser with tree navigation
• examples/getting_started/todo_app.exs: Todo list (state machine modes)
• examples/ssh/ssh_counter.exs: SSH-served counter