# Raxol

[![CI](https://github.com/Hydepwns/raxol/workflows/CI/badge.svg)](https://github.com/Hydepwns/raxol/actions/workflows/ci.yml)
[![Tests](https://img.shields.io/badge/tests-4361-brightgreen.svg)](https://github.com/Hydepwns/raxol/actions)
[![Coverage](https://img.shields.io/badge/coverage-98.7%25-brightgreen.svg)](https://codecov.io/gh/Hydepwns/raxol)
[![Performance](https://img.shields.io/badge/parser-3.3μs%2Fop-blue.svg)](bench/README.md)
[![Hex.pm](https://img.shields.io/hexpm/v/raxol.svg)](https://hex.pm/packages/raxol)
[![Documentation](https://img.shields.io/badge/docs-hexdocs-purple.svg)](https://hexdocs.pm/raxol)

## High-Performance Terminal Application Framework

Raxol brings modern UI development patterns to the terminal. Think **React, Svelte, LiveView** meets tmux.

### Why Raxol?

- **Performance**: 3.3μs parser operations, 2.8MB memory per session
- **Multi-Framework Support**: Choose React, Svelte, LiveView, or HEEx patterns
- **Enterprise Features**: Audit logging, encryption, SAML/OIDC, compliance support
- **Advanced Capabilities**: Sixel graphics, session continuity, real-time collaboration

## What's New in v1.4.1

### Automated Type Spec Generator
Generate type specifications for private functions automatically:
```bash
mix raxol.gen.specs lib/my_module.ex
mix raxol.gen.specs lib --recursive --dry-run
```

### Unified TOML Configuration
Centralized configuration with environment-specific overrides:
```elixir
Raxol.Config.get([:terminal, :width], default: 80)
Raxol.Config.set([:rendering, :fps_target], 120)
```

### Enhanced Debug Mode
Four-level debugging system with performance monitoring:
```elixir
Raxol.Debug.enable(:verbose)
Raxol.Debug.time_debug(:render, "frame", fn -> render() end)
```

## Quick Start

```bash
# Add to mix.exs
{:raxol, "~> 1.4.1"}

# Clone and explore
git clone https://github.com/Hydepwns/raxol.git
cd raxol
mix deps.get

# Run quality checks
mix raxol.check

# Run tests
mix raxol.test

# Generate type specs
mix raxol.gen.specs lib --recursive
```

## Choose Your Framework

```elixir
use Raxol.UI, framework: :react      # Familiar React patterns
use Raxol.UI, framework: :svelte     # Reactive with compile-time optimization
use Raxol.UI, framework: :liveview   # Phoenix LiveView patterns
use Raxol.UI, framework: :heex       # Phoenix templates
use Raxol.UI, framework: :raw        # Direct terminal control
```

### React-Style Example
```elixir
defmodule MyApp do
  use Raxol.Component

  def render(assigns) do
    ~H"""
    <Box padding={2}>
      <Text color="green" bold>Hello, Raxol!</Text>
      <Button on_click={@on_click}>Click me!</Button>
    </Box>
    """
  end
end
```

[View more examples →](examples/README.md)

## Key Features

### Core Terminal Framework
- Full VT100/ANSI compliance with modern extensions
- Sixel graphics and GPU acceleration
- Mouse support with full event handling
- Tab completion and command history

### Multi-Framework UI System
- Universal features across all frameworks (actions, transitions, context, slots)
- 60 FPS animation engine
- Component composition and theming

### Enterprise Features
- WASH-style session continuity
- Real-time collaboration with CRDT sync
- SOC2/HIPAA/GDPR compliant audit logging
- AES-256-GCM encryption with key rotation

## Performance Metrics

| Metric       | Raxol         | Alacritty    | Kitty        | iTerm2       | WezTerm      |
|--------------|---------------|--------------|--------------|--------------|--------------|
| Parser Speed | **3.3μs/op**  | ~5μs/op      | ~4μs/op      | ~15μs/op     | ~6μs/op      |
| Memory Usage | **2.8MB**     | ~15MB        | ~25MB        | ~50MB        | ~20MB        |
| Startup Time | **<150μs**    | ~50ms        | ~40ms        | ~100ms       | ~60ms        |
| Test Suite   | **4361 tests**| ~800 tests   | ~600 tests   | ~500 tests   | ~700 tests   |

### Additional Verified Metrics
- **Cursor Operations**: 0.5μs per movement
- **Buffer Write**: 1.2μs per character
- **Screen Clear**: <50μs for full screen
- **Scroll Performance**: 60fps maintained with 10K lines
- **Input Latency**: <1ms keyboard to screen
- **Concurrent Sessions**: 1000+ terminals per GB RAM

## Documentation

**[Full Documentation →](https://hexdocs.pm/raxol)** - Complete API reference and guides

### v1.4.1 Feature Documentation
- **Type Spec Generator** - Automated type specification generation with `mix raxol.gen.specs`
- **Unified Configuration** - TOML-based configuration system via `Raxol.Config`
- **Enhanced Debug Mode** - Advanced debugging with 4 levels via `Raxol.Debug`

## VS Code Extension

Development version available in `editors/vscode/`. To install:

```bash
cd editors/vscode
npm install
npm run compile
code --install-extension .
```

Features: Syntax highlighting, IntelliSense, component snippets, live preview

## Use Cases

Perfect for terminal IDEs, DevOps tools, system monitoring, database clients, chat applications, and games.

## License

MIT License - see [LICENSE.md](LICENSE.md)