CLI

After installing jadeui, use the unified CLI. Legacy entry points jadeui-download and jadeui-clean still work.

jadeui -V                 # SDK version
jadeui --help
jadeui <command> --help   # full flags for a subcommand

Quick workflow

jadeui init my-app --frontend html   # or vue / react
cd my-app
jadeui doctor                        # check Python / DLL / Nuitka / Node+asar
jadeui run                           # run in development
jadeui japk                          # plaintext JAPK (needs @electron/asar)
jadeui build                         # host exe (Nuitka by default)

Subcommands

init — scaffold a project

jadeui init my-app
jadeui init my-app --frontend html
jadeui init my-app --frontend vue --title "My App"
jadeui init . --frontend react --force

For vue / react, build the frontend first:

cd frontend && npm install && npm run build && cd ..

Vite output goes to web/ for JadeUI to load.

run — development run

jadeui run
jadeui run app.py
jadeui run --hot-reload

doctor — environment check

jadeui doctor

Checks Python / arch, jadeui + JadeView DLL, Nuitka, PyInstaller, compilers, Node.js / npm / asar. Missing DLL is treated as a blocker.

japk — pack front-end assets

Packs HTML/CSS/JS into a plaintext ASAR-compatible .japk (not a Python exe). See JAPK.

# Requires Node.js and: npm install -g @electron/asar
jadeui japk
jadeui japk --src web -o dist/my-app.japk
jadeui japk --list dist/my-app.japk

For signed / obfuscated production packages, use the JadePack desktop client.

build — pack host exe

See Application packaging. Missing Nuitka / PyInstaller is installed automatically (disable with --no-auto-deps).

jadeui build
jadeui build app.py -o MyApp
jadeui build --packager pyinstaller

download — download native libraries

jadeui download
jadeui download --build 26G02
jadeui download -a x64 --check

Auto-updates stay within the same release tag; they never jump to unadapted versions such as 2.4.

clean — clear caches

jadeui clean

Removes __pycache__ under the installed jadeui package.

Project conventions (pyproject.toml)

When a CLI flag is omitted, values resolve in this order:

Explicit CLI args → [tool.jadeui] → [project].name → built-in defaults

jadeui init writes a minimal file, for example:

[project]
name = "my-app"
version = "0.1.0"
description = "My App"
requires-python = ">=3.7"

[tool.jadeui]
entry = "app.py"
# output = "MyApp"          # optional; falls back to project.name
# icon = "web/favicon.png"
frontend = "web"
# packager = "nuitka"       # or pyinstaller

Notes:

• Safe to share one pyproject.toml with uv / conda / Poetry. JadeUI only uses [tool.jadeui] and does not manage lockfiles or environments.
• A parent pyproject.toml without [tool.jadeui] is ignored so SDK/monorepo roots are not inherited by accident.