CLI Reference

CLI Reference

Complete documentation for the Uvel command-line interface. Run, debug, and build your applications.


Overview

The uvel executable is your entry point for all operations. It must be in your system PATH.

Usage
uvel <command> [options]
CommandDescription
runExecute an application normally.
devRun with DevTools and Hot Reload enabled.
buildCompile the application to a standalone EXE.
newCreate a new project from a template.
--versionDisplay the installed version.
--helpShow help information.

uvel run

Starts the application in production mode. No debug logs or hot reload.

uvel run App.xml

If you don't specify a file, it looks for uvel.json or App.xml in the current folder.


uvel dev

Starts the application in development mode. This enables:

  • Hot Reload: UI updates on file save.
  • DevTools Server: Accessible at http://localhost:9222.
  • Console Logs: Output visible in terminal.
uvel dev App.xml [options]

Options

FlagDescription
-p, --port <number>Set DevTools HTTP port (default: 9222).
--no-debugDisable interactive console (useful for scripts).

Examples

uvel dev App.xml --port 8080

uvel build

Compiles your project into a single, dependency-free executable.

uvel build App.xml [options]

Options

FlagDescription
-o, --output <dir>Output directory (default: ./build).
-n, --name <name>Name of the executable (e.g., MyApp).
-i, --icon <path>Application icon (.ico file).
--consoleKeep console window visible (for debugging).
--compressOptimize binary size (removes debug symbols).

Examples

uvel build App.xml -o ./dist -n Calculator --icon icon.ico

uvel new

Creates a new project folder with starter files.

uvel new <ProjectName> [template]

Templates

NameDescription
defaultBasic Hello World app (default).
calculatorA fully functional calculator.
todoTodo list application.

Examples

# Create basic app
uvel new MyAwesomeApp

# Create calculator
uvel new MyCalc calculator