Packages

raxol

0.6.0
2.6.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.1 2.0.0 1.5.4 1.4.1 1.0.1 1.0.0 0.9.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

Multi-surface application runtime for Elixir. One TEA module renders to terminal, browser (LiveView), SSH, and MCP (agents). 30+ widgets, flexbox + CSS grid, AI agent runtime, distributed swarm with CRDTs, time-travel debugging, session recording, sandboxed REPL, and agentic commerce.

HexDocs

Current section

Files

Jump to
Readme
18 Versions
40 Dependencies
2 Dependants
Files
Activity
raxol docs README.md
Raw

docs/README.md 

---

title: Raxol Documentation

description: Complete guide to the Raxol TUI library

date: 2025-01-27

author: Raxol Team

section: overview

tags: [documentation, overview, library, tui, elixir]

---



# 📚 Raxol Documentation



Welcome to Raxol—a modern toolkit for building terminal user interfaces (TUIs) in Elixir.



## 🚀 Quick Start



1. **Setup**: [Development Guide](DEVELOPMENT.md) - Get started with Nix

2. **First App**: [Quick Start](../examples/guides/01_getting_started/quick_start.md)

3. **Examples**: [Sample Applications](../examples/)



## 📖 Core Documentation



### Development



- [Development Guide](DEVELOPMENT.md) - Setup, workflow, troubleshooting

- [Architecture](ARCHITECTURE.md) - System design and principles

- [Configuration](CONFIGURATION.md) - Settings and environment



## 🎯 Key Features



- **Terminal Emulator**: ANSI support, buffer management, cursor handling

- **Component Architecture**: Reusable UI components with state management

- **Event System**: Keyboard, mouse, window resize, and custom events

- **Theme Support**: Customizable styling with color system integration

- **Performance**: < 1ms event processing, < 2ms screen updates



## 📦 Installation



```bash

# Using Nix (recommended)

git clone https://github.com/Hydepwns/raxol.git

cd raxol

nix-shell

mix deps.get

mix setup



# Or add to your project

def deps do

  [{:raxol, "~> 0.5.0"}]

end

```



## 🔗 Resources



- [GitHub](https://github.com/Hydepwns/raxol)

- [Issues](https://github.com/Hydepwns/raxol/issues)

- [CHANGELOG](../CHANGELOG.md)