create-qauri

Project scaffolding tool for Qauri.

Usage

# npm
npm create qauri@latest

# pnpm
pnpm create qauri

# yarn
yarn create qauri

Optionally specify a project name:

npm create qauri@latest my-app

What It Generates

The generator walks through an interactive wizard and produces a project that is already aligned with the current C++ runtime contract:

• explicit runtime boot for Python entry points
• numeric backend enums
• numeric boot mode protocol
• nested config structure under app.windows, app.security, and webview.newWindow.policy

Wizard choices include:

1. project name
2. native language: C++ or Python
3. Python environment preferences for Python projects
4. Qt version and path
5. backend: WebView2, CEF, or Both
6. frontend framework
7. feature toggles such as DevTools and reload
8. new-window behavior
9. dependency installation

Generated Configuration

Generated src-qauri/qauri.config.json uses the current shape and numeric enums:

{
  "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,
    "newWindow": {
      "policy": 1
    }
  }
}

Numeric enum mapping:

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

Python Projects

Generated Python entry files use explicit runtime boot:

from pyqauri import BootMode, QauriRuntime

QauriRuntime.boot(BootMode.DEV)

There is no implicit boot path in generated templates.

build.python is omitted by default. Add it only if you need a non-default entry file or interpreter:

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

Virtual environments should live at the project root:

cd my-qauri-app
python -m venv .venv

Generated Project Structure

my-qauri-app/
  index.html
  package.json
  src/
  src-qauri/
    qauri.config.json
    main.cpp / main.py
    CMakeLists.txt
  .gitignore
  README.md

Supported Templates

Frontend frameworks:

• Vanilla
• Vanilla + TypeScript
• React
• React + TypeScript
• Vue
• Vue + TypeScript
• Svelte
• Svelte + TypeScript

Native languages:

• C++
• Python

Development

For repository development:

npm install
npm run build
npm test

For generated application development, use qauri-cli:

qauri dev
qauri build
qauri info