@qauri/create-qauri

Scaffolding tool for creating Qauri projects with interactive prompts.

Usage

# npm
npm create @qauri/qauri@latest

# pnpm
pnpm create @qauri/qauri

# yarn
yarn create @qauri/qauri

Optionally specify a project name:

npm create @qauri/qauri@latest my-app

What it does

The CLI walks you through an interactive wizard to configure your project:

1. Project name — validates naming conventions
2. Native language — C++ or Python
3. Python configuration (if Python selected):
   • Package manager (pip or uv)
   • Python version (3.9-3.12)
   • Python path detection
4. Qt configuration:
   • Qt version (6.5.3, 6.9.2)
   • Qt path detection
5. Backend — WebView2 (Windows), CEF (cross-platform), or Both
6. Frontend framework — Vanilla, React, Vue, or Svelte (with TypeScript variants)
7. Features — DevTools (F12), Reload (F5), Command Whitelist, Examples
8. New window behavior — Block, Browser, or New Window
9. Install dependencies — Automatically run npm install

Then generates a complete project structure ready for development.

Generated Project Structure

my-qauri-app/
├── index.html
├── package.json
├── vite.config.js
├── src/                    # Frontend source
│   └── ...
├── src-qauri/              # Native code
│   ├── qauri.config.json
│   ├── main.cpp / main.py
│   └── CMakeLists.txt      # (C++ only)
├── .gitignore
└── README.md

Supported Templates

Frontend Frameworks

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

All templates use Vite as the build tool and include @qauri/api for JS↔Native communication.

Native Languages

• C++ — CMake project linking Qt6 and qauri
• Python — PySide6 + pyqauri, with uv or pip environment setup

Development

For development on the Qauri project itself, use @qauri/cli:

npm install -g @qauri/cli
qauri dev
qauri build
qauri info

License

MIT

Links

• Qauri Web Component
• Qauri CLI
• Qauri JS SDK