mix raxol.new (Raxol v2.3.0)

View Source

Generates a new Raxol TUI application.

Usage

mix raxol.new my_app

When run without flags, an interactive prompt guides you through setup. Pass flags to skip prompts.

Options

  • --module - The main module name (default: derived from app name)
  • --sup - Generate an OTP application with a supervision tree
  • --ssh - Include SSH server boilerplate for remote access
  • --liveview - Include Phoenix LiveView bridge for browser rendering
  • --template - Starter template: counter (default), blank, todo, dashboard
  • --ci - Generate GitHub Actions CI workflow
  • --no-test - Skip generating test files
  • --install - Run mix deps.get, compile, and test after generation
  • --list - Show available templates with descriptions

Examples

mix raxol.new dashboard
mix raxol.new my_tui --module MyTUI
mix raxol.new my_app --sup --template todo --ci
mix raxol.new my_app --ssh --install
mix raxol.new --list