Packages

raxol

2.1.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
35 Dependencies
2 Dependants
Files
Activity
raxol docs README.md
Raw

docs/README.md 

# Raxol Documentation



Complete guide to building terminal applications with Raxol.



## Essentials

- [Getting Started](getting-started/QUICKSTART.md) - 5/10/15 minute tutorials

- [Package Guide](getting-started/PACKAGES.md) - Choose your packages

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



## Features

- [VIM Navigation](features/VIM_NAVIGATION.md)

- [Command Parser](features/COMMAND_PARSER.md)

- [Fuzzy Search](features/FUZZY_SEARCH.md)

- [All Features →](features/README.md)



## Cookbook

- [LiveView Integration](cookbook/LIVEVIEW_INTEGRATION.md)

- [Performance](cookbook/PERFORMANCE_OPTIMIZATION.md)

- [Theming](cookbook/THEMING.md)



## Guides

- [Custom Components](guides/custom_components.md)

- [Multi-Framework](guides/multi_framework_migration_guide.md)

- [Accessibility](guides/accessibility_implementation_guide.md)



## Advanced

- [Architecture Decisions](adr/)

- [Plugin Development](plugins/)

- [Benchmarks](bench/)



## Resources



- **[HexDocs](https://hexdocs.pm/raxol)** - Complete API reference

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

- **[ROADMAP](../ROADMAP.md)** - Development roadmap

- **[Issues](https://github.com/Hydepwns/raxol/issues)** - Bug reports & features



---



**Questions?** [Open an issue](https://github.com/Hydepwns/raxol/issues)