{"id":31637635,"url":"https://github.com/hydepwns/raxol","last_synced_at":"2025-10-07T01:38:41.631Z","repository":{"id":286032417,"uuid":"949664843","full_name":"Hydepwns/raxol","owner":"Hydepwns","description":"Fast, component-based terminal UIs for Elixir","archived":false,"fork":false,"pushed_at":"2025-10-03T18:18:09.000Z","size":28921,"stargazers_count":24,"open_issues_count":7,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-03T20:26:47.424Z","etag":null,"topics":["ansi","component-based","elixir","elm","nextjs","otp","phoenix","phoenix-liveview","react","sixel-graphics","svelte","terminal-emulator","terminal-ui","tui","vt-terminal","web-terminal"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Hydepwns.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/security.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-03-16T23:47:39.000Z","updated_at":"2025-10-03T04:39:00.000Z","dependencies_parsed_at":"2025-08-01T01:03:02.451Z","dependency_job_id":"53eeb8cc-ee4c-4b10-8ea2-c2948124510f","html_url":"https://github.com/Hydepwns/raxol","commit_stats":null,"previous_names":["hydepwns/raxol"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/Hydepwns/raxol","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hydepwns%2Fraxol","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hydepwns%2Fraxol/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hydepwns%2Fraxol/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hydepwns%2Fraxol/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Hydepwns","download_url":"https://codeload.github.com/Hydepwns/raxol/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hydepwns%2Fraxol/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278708073,"owners_count":26031932,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ansi","component-based","elixir","elm","nextjs","otp","phoenix","phoenix-liveview","react","sixel-graphics","svelte","terminal-emulator","terminal-ui","tui","vt-terminal","web-terminal"],"created_at":"2025-10-07T01:38:37.142Z","updated_at":"2025-10-07T01:38:41.626Z","avatar_url":"https://github.com/Hydepwns.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Raxol\n\n[![CI](https://github.com/Hydepwns/raxol/workflows/CI/badge.svg)](https://github.com/Hydepwns/raxol/actions/workflows/ci.yml)\n[![Tests](https://img.shields.io/badge/tests-793%20(100%25%20pass)-brightgreen.svg)](https://github.com/Hydepwns/raxol/actions)\n[![Coverage](https://img.shields.io/badge/coverage-98.7%25-brightgreen.svg)](https://codecov.io/gh/Hydepwns/raxol)\n[![Performance](https://img.shields.io/badge/parser-3.2μs%2Fseq-brightgreen.svg)](bench/README.md)\n[![Hex.pm](https://img.shields.io/hexpm/v/raxol.svg)](https://hex.pm/packages/raxol)\n[![Documentation](https://img.shields.io/badge/docs-hexdocs-purple.svg)](https://hexdocs.pm/raxol)\n\n## Terminal Application Framework\n\nTerminal framework supporting React, Svelte, LiveView, and HEEx UI patterns.\n\n### Features\n\n- Sub-microsecond parser operations\n- Multi-framework UI support (React, Svelte, LiveView, HEEx)\n- Enterprise features: audit logging, encryption, SAML/OIDC\n- Graphics: Sixel support, session continuity\n- **NEW**: VIM navigation, command parser, fuzzy search, virtual filesystem, cursor effects\n\n## Modular Packages (v2.0+)\n\nRaxol is now available as focused, independently releasable packages:\n\n- **[raxol_core](https://hex.pm/packages/raxol_core)** - Lightweight buffer primitives (\u003c 100KB, zero deps)\n- **[raxol_liveview](https://hex.pm/packages/raxol_liveview)** - Phoenix LiveView integration\n- **[raxol_plugin](https://hex.pm/packages/raxol_plugin)** - Plugin system\n- **raxol** - Full framework (includes all packages)\n\nSee **[Package Guide](docs/getting-started/PACKAGES.md)** for detailed comparison, migration paths, and installation instructions.\n\n## Quick Start\n\n### Installation\n\nChoose your package based on needs:\n\n```elixir\n# Minimal - Just terminal buffers\n{:raxol_core, \"~\u003e 2.0\"}\n\n# Web integration - Add LiveView support\n{:raxol_core, \"~\u003e 2.0\"},\n{:raxol_liveview, \"~\u003e 2.0\"}\n\n# Extensible apps - Add plugin system\n{:raxol_core, \"~\u003e 2.0\"},\n{:raxol_plugin, \"~\u003e 2.0\"}\n\n# Or use v1.x (full framework)\n{:raxol, \"~\u003e 2.0\"}\n```\n\nUsing `runtime: false` provides UI components without terminal emulator runtime for:\n- Web applications\n- Component libraries\n- Testing UI logic\n- Reduced application size\n\n### Development Setup\n\n```bash\n# Clone and explore\ngit clone https://github.com/Hydepwns/raxol.git\ncd raxol\nmix deps.get\n\n# Run quality checks\nmix raxol.check\n\n# Run tests\nTMPDIR=/tmp SKIP_TERMBOX2_TESTS=true MIX_ENV=test mix test\n\n# Generate type specs\nmix raxol.gen.specs lib --recursive\n```\n\n## Choose Your Framework\n\n```elixir\nuse Raxol.UI, framework: :react      # Familiar React patterns\nuse Raxol.UI, framework: :svelte     # Reactive with compile-time optimization\nuse Raxol.UI, framework: :liveview   # Phoenix LiveView patterns\nuse Raxol.UI, framework: :heex       # Phoenix templates\nuse Raxol.UI, framework: :raw        # Direct terminal control\n```\n\n### React-Style Example\n```elixir\ndefmodule MyApp do\n  use Raxol.Component\n\n  def render(assigns) do\n    ~H\"\"\"\n    \u003cBox padding={2}\u003e\n      \u003cText color=\"green\" bold\u003eHello, Raxol!\u003c/Text\u003e\n      \u003cButton on_click={@on_click}\u003eClick me!\u003c/Button\u003e\n    \u003c/Box\u003e\n    \"\"\"\n  end\nend\n```\n\n### Emulator Usage\n```elixir\n# Default configuration\nemulator = Emulator.new(80, 24)\n\n# With GenServers for concurrent operations\nemulator = Emulator.new(80, 24, use_genservers: true)\n\n# Minimal configuration\nemulator = Emulator.new(80, 24, enable_history: false, alternate_buffer: false)\n```\n\n[View more examples →](examples/README.md)\n\n## Components-Only Mode\n\nWhen importing Raxol with `runtime: false`, you get access to:\n\n### UI Components\n- All framework adapters (React, Svelte, LiveView, HEEx)\n- Complete component library (Button, Input, Table, Modal, etc.)\n- State management and context systems\n- Animation and transition engines\n- Theme system and styling utilities\n\n### Not Included in Components-Only\n- Terminal emulator runtime\n- ANSI/VT100 sequence processing\n- PTY/TTY management\n- SSH session handling\n- Sixel graphics rendering\n\nThis makes Raxol perfect as a lightweight UI component library for web applications or other non-terminal use cases.\n\n## Architecture\n\n### Terminal Framework\n- VT100/ANSI compliance with modern extensions\n- Sixel graphics, GPU acceleration\n- Mouse support, event handling\n- Tab completion, command history\n\n### UI System\n- Universal features: actions, transitions, context, slots\n- 60 FPS animation engine\n- Component composition, theming\n\n### Enterprise Features\n- Session continuity\n- Real-time collaboration with CRDT sync\n- SOC2/HIPAA/GDPR audit logging\n- AES-256-GCM encryption with key rotation\n\n## Performance\n\n| Metric       | Raxol         | Alacritty    | Kitty        | iTerm2       | WezTerm      |\n|--------------|---------------|--------------|--------------|--------------|--------------|\n| Parser Speed | 3.3μs/op      | ~5μs/op      | ~4μs/op      | ~15μs/op     | ~6μs/op      |\n| Memory Usage | 2.8MB         | ~15MB        | ~25MB        | ~50MB        | ~20MB        |\n| Startup Time | \u003c10ms         | ~50ms        | ~40ms        | ~100ms       | ~60ms        |\n| Test Suite   | 793 tests     | ~800 tests   | ~600 tests   | ~500 tests   | ~700 tests   |\n\n### Additional Metrics\n- Cursor Operations: 0.5μs per movement\n- Buffer Write: 1.2μs per character\n- Screen Clear: \u003c50μs for full screen\n- Input Latency: \u003c2ms keyboard to screen\n- Render Performance: 60 FPS maintained\n\n## Documentation\n\n### Getting Started\n\n- **[Quickstart](https://github.com/Hydepwns/raxol/blob/master/docs/getting-started/QUICKSTART.md)** - 5/10/15 minute tutorials\n- **[Core Concepts](https://github.com/Hydepwns/raxol/blob/master/docs/getting-started/CORE_CONCEPTS.md)** - Understand buffers and rendering\n- **[Migration Guide](https://github.com/Hydepwns/raxol/blob/master/docs/getting-started/MIGRATION_FROM_DIY.md)** - For teams with existing terminal code\n\n### Cookbooks\n\n- **[LiveView Integration](https://github.com/Hydepwns/raxol/blob/master/docs/cookbook/LIVEVIEW_INTEGRATION.md)** - Render terminals in Phoenix\n- **[Performance Optimization](https://github.com/Hydepwns/raxol/blob/master/docs/cookbook/PERFORMANCE_OPTIMIZATION.md)** - 60fps techniques\n- **[Theming](https://github.com/Hydepwns/raxol/blob/master/docs/cookbook/THEMING.md)** - Custom color schemes\n\n### Features\n\n- **[VIM Navigation](https://github.com/Hydepwns/raxol/blob/master/docs/features/VIM_NAVIGATION.md)** - VIM-style keybindings and movement\n- **[Command Parser](https://github.com/Hydepwns/raxol/blob/master/docs/features/COMMAND_PARSER.md)** - Tab completion, history, argument parsing\n- **[Fuzzy Search](https://github.com/Hydepwns/raxol/blob/master/docs/features/FUZZY_SEARCH.md)** - Multi-mode search with highlighting\n- **[File System](https://github.com/Hydepwns/raxol/blob/master/docs/features/FILESYSTEM.md)** - Virtual filesystem with Unix commands\n- **[Cursor Effects](https://github.com/Hydepwns/raxol/blob/master/docs/features/CURSOR_EFFECTS.md)** - Visual trails and glow effects\n- **[Features Overview](https://github.com/Hydepwns/raxol/blob/master/docs/features/README.md)** - Complete guide to all features\n\n### API Reference\n\n- **[Buffer API](https://github.com/Hydepwns/raxol/blob/master/docs/core/BUFFER_API.md)** - Complete buffer operations reference\n- **[Architecture](https://github.com/Hydepwns/raxol/blob/master/docs/core/ARCHITECTURE.md)** - Design decisions and internals\n- **[Full Documentation](https://hexdocs.pm/raxol)** - Complete API reference\n\n### Recent Features\n- **Feature Additions** (v2.0.0 Phase 6) - VIM navigation, command parser, fuzzy search, filesystem, cursor effects\n- **Documentation Overhaul** (v2.0.0 Phase 4) - Beginner-friendly guides and practical cookbooks\n- **Plugin System** (v2.0.0 Phase 3) - Spotify plugin showcase\n- **LiveView Integration** (v2.0.0 Phase 2) - Terminal rendering in Phoenix\n- **Raxol.Core** (v2.0.0 Phase 1) - Lightweight buffer primitives (\u003c 100KB, zero deps)\n- **Code Consolidation** (v1.5.4) - BaseManager pattern, TimerManager integration, 99.8% test coverage\n- **Type Spec Generator** (v1.4.1) - Automated type specification generation\n- **Unified Configuration** (v1.4.1) - TOML-based configuration system\n\n## VS Code Extension\n\nDevelopment version available in `editors/vscode/`. To install:\n\n```bash\ncd editors/vscode\nnpm install\nnpm run compile\ncode --install-extension .\n```\n\nFeatures: syntax highlighting, IntelliSense, component snippets, live preview\n\n## Use Cases\n\nUse cases: terminal IDEs, DevOps tools, system monitoring, database clients, chat applications, games.\n\n## License\n\nMIT License - see [LICENSE.md](LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhydepwns%2Fraxol","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhydepwns%2Fraxol","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhydepwns%2Fraxol/lists"}