Skip to main content

CLI Reference

Commands below that use examples/... assume the standalone examples repository is the current working directory.

The pywee command is the main developer interface.

pywee init​

Create a new app skeleton:

pywee init my-app

Use --force to overwrite generated files.

pywee validate​

Validate pywee.toml:

pywee validate examples/hello-world

pywee inspect​

Print the script loading plan:

pywee inspect examples/hello-world

pywee run​

Run an app through the PyWee-managed Chromium runtime:

pywee run examples/hello-world

Useful verification flags:

pywee run examples/hello-world --no-window --dump-dom
pywee run examples/tic-tac-toe --event '#reset:click' --dump-dom --no-window

pywee run uses the Python environment that launched pywee.

pywee smoke​

Run the headless DOM prototype used by tests:

pywee smoke examples/hello-world --dump-dom

This command is useful for fast script-loading checks. It is not the graphical Chromium runtime.

pywee dev​

Run the app with development-oriented output:

pywee dev examples/hello-world

--no-run prints the active Python executable and prefix without opening the app.

pywee pip​

Run pip in the current Python environment with the app root as the working directory:

pywee pip examples/camera-cv2 install opencv-python

Install dependencies declared in [python].requirements:

pywee pip examples/camera-cv2 install-deps

pywee build​

Create a prototype distributable archive:

pywee build linux-x64 examples/hello-world

The build command is still prototype-level. Production installers remain future work.

pywee chromium status​

Show the managed Chromium location:

pywee chromium status

If this reports chromium: missing, the installed package does not contain the runtime yet.

pywee chromium install​

Download the locked Chromium runtime into the PyWee cache:

pywee chromium install

pywee chromium verify​

Verify the installed executable against the lock metadata and require complete offline license evidence:

pywee chromium verify

The command fails when .pywee-chromium.json, CHROMIUM_CREDITS.html, the Chromium license, or the Playwright provider license is missing or invalid.