qauri-cli

CLI for developing, building, and inspecting Qauri applications.

It also ships the create-qauri-app entry point for project scaffolding, but the primary runtime commands are:

• qauri dev
• qauri build
• qauri info

Install

npm install -g qauri-cli

Or run it from the repository:

node packages/qauri-cli/dist/index.mjs dev
node packages/qauri-cli/dist/index.mjs build
node packages/qauri-cli/dist/index.mjs info

Current Contract

The CLI is aligned with the current C++ runtime contract:

• runtime boot is explicit
• QAURI_BOOT_MODE uses numeric protocol values
• config uses productName/version/identifier
• window config lives under app.windows
• security config lives under app.security
• new-window handling lives under webview.newWindow.policy
• backend enums are numeric

Numeric enum mapping:

• backendType: 0=auto, 1=webview2, 2=cef
• newWindow.policy: 0=smart, 1=block, 2=allow, 3=browser, 4=current
• QAURI_BOOT_MODE: 0=release, 1=dev

Commands

qauri dev

Starts frontend dev mode, prepares environment variables, and launches the native app in development mode.

qauri dev
qauri dev --verbose

The CLI sets:

• QAURI_BOOT_MODE=1
• QAURI_DEV_URL=<build.devUrl>
• QAURI_CONFIG_PATH=<absolute path to qauri.config.json>

qauri build

Builds frontend assets, generates the runtime manifest, packages resources, and produces a release build.

qauri build
qauri build --verbose

qauri info

Prints resolved project information and active configuration.

qauri info

Configuration Shape

Generated and supported configs use the current nested structure:

{
  "productName": "My App",
  "version": "0.1.0",
  "identifier": "com.example.myapp",
  "build": {
    "beforeDevCommand": "npm run dev",
    "beforeBuildCommand": "npm run build",
    "devUrl": "http://localhost:5173",
    "frontendDist": "../dist",
    "backend": 1
  },
  "app": {
    "windows": [
      {
        "label": "main",
        "title": "My App",
        "width": 1200,
        "height": 800
      }
    ],
    "security": {
      "allowedOrigins": [
        "https://example.com"
      ]
    }
  },
  "webview": {
    "backendType": 1,
    "devtools": true,
    "contextMenu": true,
    "refresh": true,
    "fullscreen": true,
    "zoom": true,
    "newWindow": {
      "policy": 1
    }
  }
}

Old string enum values and removed field layouts are no longer supported.

Python Projects

For Python projects, the generated entry point uses explicit runtime boot:

from pyqauri import BootMode, QauriRuntime

QauriRuntime.boot(BootMode.DEV)

build.python is optional. Add it only when you need a non-default entry file or a specific Python executable:

{
  "build": {
    "python": {
      "entryFile": "main.py",
      "executable": "D:/Python311/python.exe"
    }
  }
}

More Detail

For the full workflow guide, environment variables, and troubleshooting, see docs/usage.md.