Docs · Technical preview

A small framework needs a short start.

The command set is stable enough to document; public artifacts are still being validated.

The SDK is not publicly downloadable yet. The commands below are the intended public workflow; they become usable when the technical preview opens.

Quickstart

Create an app, run it, then pack it. The client stays ordinary HTML, CSS and JavaScript.

avelra init my-app
cd my-app
avelra run

When you are ready to produce a single executable:

avelra build

Requirements

  • Linux: GTK 3.24+ and WebKitGTK 4.1.
  • Windows: Windows 10 1809+, WebView2 Evergreen Runtime and the VC++ 2015–2022 x64 runtime.
  • macOS: macOS 12+ on arm64. WebKit is part of the OS.

Use the built-in check before opening a window:

avelra doctor

Commands

  • avelra init <dir>Create a project from the starter template.
  • avelra runRun the development runtime against avelra.config.json.
  • avelra buildPack the client into a single executable.
  • avelra doctorCheck platform runtime dependencies without opening a GUI.

Config

avelra.config.json describes the app name, client directory and window:

{
  "name": "My App",
  "client": "client",
  "window": { "title": "My App", "width": 960, "height": 600 }
}

Current limits

Linux is the verified platform. Windows and macOS builds and preflight checks are in CI, but real WebView runtime validation is still in progress. Code signing and notarization are not part of the technical preview. See the roadmap for release gates.