Open Web Desktop (OWD) is an open-source framework built on top of Nuxt.js, used to create web-based operating systems and interactive, window-driven desktop experiences directly inside a web browser.
Demo · Documentation · Support
- Desktop extendable through apps, modules, and themes
- Bundled with popular libraries like Pinia and VueUse
- Designed to make the most of the Nuxt.js ecosystem
- Supports any UI kit, such as PrimeVue, Nuxt UI, and Vuetify
- Fully localizable with nuxt-i18n support
- Easy to learn and extend via
pnpm desktop
desktop/— dev desktop (workspace apps, modules, themes)template/— scaffold copied bynpm create owd@latest/pnpm desktop init.
Do not edit "template" by hand; regenerate withpnpm desktop templateafter changing the starter desktop or publishing@owdproject/*packages. Blueprint sources live inpackages/core/template-blueprint/.
To create a new Open Web Desktop project:
Run the initializer command to scaffold your project:
npm create owd@latestInstall the project dependencies using pnpm:
pnpm installRun the dev server directly:
pnpm run devOr start the control panel (TUI) to manage packages and logs:
pnpm run desktop(Press d in the control panel to toggle the dev server, x to stop).
Open Web Desktop is designed to scale via modular extension packages.
You can customize your workspace using three dedicated package types:
| Type | Description | Directory | Discovery Tag |
|---|---|---|---|
| Apps | User-facing desktop application programs | apps/ | owd-apps |
| Modules | Nuxt/Vue plugins and backend integrations | packages/ | owd-modules |
| Themes | Window manager styles and workspace skins | themes/ | owd-themes |
The CLI makes it easy to install, import, and configure packages automatically.
Note
For security reasons, the Control Panel (CP) only displays packages from a whitelist of approved GitHub usernames like owdproject and atproto-os. Modules from other users will not appear automatically, although this discovery mechanism is planned to be improved in the future.
To add a new application (e.g., a Todo app):
pnpm desktop add app-todoThis command clones or copies the package into apps/app-todo and automatically registers it in the local desktop/desktop.config.ts config.
To add a module (e.g., Pinia state persistence):
pnpm desktop add module-persistenceTo add a theme (e.g., a GNOME look-and-feel package):
pnpm desktop add theme-gnomeYou can install packages from various sources, specifying different branches or protocols. Run the CLI with --help (e.g. pnpm desktop add --help) to discover all available flags and options:
# Show help and all available options for the add command
pnpm desktop add --help
# Install directly from the npm registry
pnpm desktop add app-todo --npm
# Clone from a specific GitHub user fork
pnpm desktop add module-persistence --from github-username
# Clone an official repository in development mode
pnpm desktop add app-todo --dev
# Install a specific branch from a user fork using SSH protocol
pnpm desktop add theme-gnome --from github-username --branch feature-branch --protocol sshFor developers building reusable packages (e.g., publishable apps or themes in isolation), OWD supports playground builds using nuxt-module-build.
- Learn more about the playground setup in docs/agents/OWD_APP_MODULE_PLAYGROUND.md.
- Reference examples: app-about and app-wasmboy.
To view all available commands and options for the OWD CLI, run:
pnpm desktop --helpView complete CLI Help Menu
desktop — add apps, modules, and themes to your Open Web Desktop
USAGE
desktop Open the control panel (interactive TUI)
desktop dev [--playground] Start dev server (auto-detects module playground)
CONTROL PANEL (TUI)
m Open command menu (all actions)
s Start the Nuxt dev server
x Stop the Nuxt dev server
R Reboot the Nuxt dev server (stop + start)
w Save catalog/theme changes to desktop.config.ts
1 / 2 / 3 Apps / Modules / Themes catalog tabs
o / O Cycle sort (o) or open sort picker (O)
i Open in-app docs (when module-docs is installed)
g Settings (GitHub user, SSH, trusted orgs)
r Refresh package list from GitHub (detects new modules)
b Run pnpm run generate
q / Esc Quit
desktop init [dir] Create a new OWD project (then opens the control panel)
desktop add <package> [options]
desktop add <kind> <name> [options]
desktop validate [path...] Check Nuxt module + playground layout
desktop template [--dry-run] [--check] Regenerate client/template/ (maintainers)
TEMPLATE (monorepo maintainers)
desktop template Write template/ from blueprint + desktop/ + latest npm versions
desktop template --dry-run Show planned @owdproject/* and starter versions
desktop template --check Fail if committed template/ differs (CI)
VALIDATE
desktop validate Validate cwd package, or all apps/themes/modules at repo root
desktop validate . Validate explicit package directory
desktop validate apps Validate every @owdproject/* module under apps/
--json Machine-readable output
--strict Treat warnings as failures
--smoke Run dev:prepare + nuxt build playground (slow, CI)
INSTALL SOURCES (control panel or CLI)
npm registry (default for desktop add)
--dev clone github.com/owdproject/<package>
--from <user> clone from GitHub user or full git URL (SSH supported)
EXAMPLES
pnpm desktop # control panel
pnpm desktop dev # monorepo desktop (from repo root)
cd apps/app-about && pnpm desktop dev # app-about playground
pnpm desktop dev --playground # force playground when cwd is in a module
desktop init my-desktop # scaffold + pnpm install + control panel
desktop add app-todo --npm
desktop add app-todo --dev
desktop add module-persistence --from dxlliv
KINDS (optional — inferred from the package name)
app app-* → apps/
module module-* → packages/ (kit-* and *-template are not listed in the control panel)
theme theme-* → themes/
OPTIONS
--playground Start the module playground dev server (when cwd is inside an @owdproject/* package with playground/)
--from <source> Git source (user, user/repo, or URL)
--branch <name> Git branch to clone
--npm Install from npm (default when --from is omitted)
--dev, --workspace Clone from github.com/owdproject/<package>
--protocol https|ssh With --from <user>, use HTTPS (default) or SSH clone URL
--dry-run Print the plan without changing anything
-h, --help Show this help
--from <source>
(omit) npm registry (default)
npm npm registry
owdproject Clone official repo (monorepo only)
<github-user> Clone github.com/<user>/<package> (your fork)
<user>/<repo> Explicit GitHub repo
<git-url> Full clone URL
LEGACY (still supported)
desktop install-app @owdproject/app-todo
→ prefer: desktop add app-todo
Open Web Desktop is released under the MIT License.