Packages
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.
Current section
Files
Jump to
Current section
Files
docs/CONSOLIDATED_README.md
---
title: Raxol Documentation Hub
description: Complete documentation for the Raxol full-stack terminal application framework
date: 2025-07-27
author: Raxol Team
section: documentation
tags: [documentation, hub, guide, reference, framework]
---
# Raxol Documentation Hub
Welcome to Raxol—a full-stack terminal application framework for Elixir that enables you to build sophisticated terminal applications with both local and web interfaces.
## 🚀 Quick Start
1. **Installation**: Choose your preferred method
- [Nix Development Environment](DEVELOPMENT.md#quick-setup) (Recommended)
- [Manual Installation](DEVELOPMENT.md#prerequisites)
2. **First Application**: [Quick Start Guide](../examples/guides/01_getting_started/quick_start.md)
3. **Interactive Demos**:
```bash
mix run bin/demo.exs # Interactive menu
mix run bin/demo.exs form # Specific demo
```
## 📚 Documentation Structure
### Core Documentation
- [Architecture](ARCHITECTURE.md) - Full system architecture including web and plugin layers
- [Development Guide](DEVELOPMENT.md) - Setup, workflow, and web development
- [Configuration](CONFIGURATION.md) - Settings and environment configuration
- [Web Interface Guide](WEB_INTERFACE_GUIDE.md) - Phoenix LiveView integration and web features
- [Plugin System Guide](PLUGIN_SYSTEM_GUIDE.md) - Creating and managing plugins
### Component System
- [Component Guide](./components/README.md) - Complete component reference for terminal and web
- [Component API](./components/api/README.md) - API documentation with lifecycle details
- [Style Guide](./components/style_guide.md) - Theming and styling patterns
### User Guides
- [Getting Started](../examples/guides/01_getting_started/) - Installation, first app, and web access
- [Core Concepts](../examples/guides/02_core_concepts/) - Framework architecture and concepts
- [Component Reference](../examples/guides/03_component_reference/) - Detailed component documentation
- [Extending Raxol](../examples/guides/04_extending_raxol/) - Plugins, integrations, and customization
- [Development & Testing](../examples/guides/05_development_and_testing/) - Testing patterns and best practices
- [Enterprise Features](../examples/guides/06_enterprise/) - Authentication, monitoring, and deployment
### Examples & Snippets
- [Example Browser](../examples/snippets/README.md) - Interactive examples
- [Basic Examples](../examples/snippets/basic/) - Simple patterns
- [Advanced Examples](../examples/snippets/advanced/) - Complex implementations
- [Showcase](../examples/snippets/showcase/) - Feature demonstrations
## 🎯 Key Features
### Core Framework Components
- **Advanced Terminal Emulator**: Full ANSI/VT100+ compliance with Sixel graphics, Unicode support, and buffer management
- **Component-Based UI System**: React-style components with lifecycle hooks, state management, and declarative rendering
- **Real-Time Web Interface**: Phoenix LiveView integration for browser-based terminal access with collaborative features
- **Extensible Plugin Architecture**: Runtime plugin loading with command registration and event hooks
- **Enterprise Features**: Built-in authentication, metrics, monitoring, and security features
### Performance & Scalability
- **Rendering Speed**: < 2ms frame time for complex UIs
- **Input Latency**: < 1ms local, < 5ms for web sessions
- **Concurrent Users**: Supports 100+ simultaneous sessions
- **Memory Efficiency**: Optimized buffer management with configurable limits
## 🔗 External Resources
- [GitHub Repository](https://github.com/Hydepwns/raxol)
- [HexDocs](https://hexdocs.pm/raxol/0.9.0)
- [Issue Tracker](https://github.com/Hydepwns/raxol/issues)
- [Discussions](https://github.com/Hydepwns/raxol/discussions)
- [Changelog](../CHANGELOG.md)
## 🚀 Framework Capabilities
Raxol is more than a terminal UI toolkit—it's a comprehensive framework for building modern terminal applications that can run locally or be accessed through the web. Whether you're building development tools, administrative interfaces, or collaborative applications, Raxol provides the foundation you need.
---
*This documentation hub provides comprehensive guides for the Raxol full-stack terminal application framework.*