create-owd
v0.0.8
Published
Scaffold a new Open Web Desktop project
Maintainers
Readme
create-owd is the installer CLI tool for Open Web Desktop, a modular framework for building web-based desktop experiences and digital gardens.
Usage
# Start interactively and choose your preferred setup type
npm create owd
# or specify the target folder directly
npm create owd my-desktopYou can also pass arguments to skip prompts and configure the setup directly:
# Recommended: clone the entire owdproject/client workspace repository
npm create owd my-desktop --clone
# Start from the standard template only
npm create owd my-desktop --templateWhat happens
- Clones the entire
owdproject/clientrepository from GitHub (recommended), or copies the official template starter structure. - Runs
pnpm installto setup all dependencies. - Automatically opens the interactive control panel UI (
desktop).
After setup
cd my-desktop
pnpm desktop # Open the control panel (TUI) to manage packages and dev server
pnpm run dev # Or start the Nuxt dev server directlyAdd apps, modules, and themes
Use the OWD CLI commands inside your project to easily install, import, and configure modules:
pnpm desktop add app-todo
pnpm desktop add module-fs
pnpm desktop add theme-novaDevelopment
From the OWD client monorepo, sync the shared scaffold before publishing:
node create-owd/scripts/vendor-scaffold.jsprepack runs this automatically when publishing create-owd to npm.
