@owdproject/cli 0.0.3 → 0.2.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025  Open Web Desktop Team ~ github.com/owdproject
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,33 +1,67 @@
-# Open Web Desktop CLI
+<p align="center">
+  <img width="160" height="160" src="https://avatars.githubusercontent.com/u/65117737?s=160&v=4" />
+</p>
+<h1 align="center">CLI</h1>
+<h3 align="center">
+  Control Panel and Command Line Interface for Open Web Desktop.
+</h3>
 
-This command-line interface (CLI) provides a set of tools to easily manage your project.
+<br />
+
+## Overview
+
+This package provides the official `desktop` (and legacy `owd`) CLI tool for Open Web Desktop. It features a rich Terminal User Interface (TUI) Control Panel to manage your running local OWD dev server, install/remove apps, modules, and themes, configure workspace settings, and scaffold new OWD components.
 
 ## Installation
 
-To install the CLI globally, run:
+```bash
+pnpm add -g @owdproject/cli
+```
+*Note: You can also install it as a devDependency in your OWD workspace project and run it via `pnpm desktop`.*
 
-`npm install -g @owdproject/cli`
+## Features
+
+- **Control Panel (TUI)**: An interactive terminal interface for managing OWD projects.
+- **Scaffolding**: Instantly initialize new workspaces or scaffold new apps and themes.
+- **Package Management**: Install and validate OWD modules from npm, local directories, or custom Git repositories.
+- **Graceful Fallback**: The interactive Control Panel compiles a fast Go-based TUI locally, falling back seamlessly to a JavaScript runner if Go is not available.
 
 ## Usage
 
-Once installed, you can use the CLI commands by typing `npx @owdproject/cli` followed by a command.
+Once installed, run the `desktop` command to open the control panel:
 
-### Available Commands
+```bash
+pnpm desktop
+```
 
-- `npx @owdproject/cli create`: Create a new Open Web Desktop project from a template.
-- `npx @owdproject/cli start`: Start the project in development mode (runs Nuxt.js).
-- `npx @owdproject/cli generate`: Generate the project for static deployment.
+### CLI Reference
 
-For more information on each command, use:
+#### Dev Server
+Start the development server for the monorepo or automatically detect a module's playground:
+```bash
+pnpm desktop dev [--playground]
+```
 
-`npx @owdproject/cli <command> --help`
+#### Add Packages
+Install apps, modules, or themes from npm, local directories, or custom repositories:
+```bash
+pnpm desktop add app-todo --npm
+pnpm desktop add theme-nova --dev
+pnpm desktop add module-fs --from <github-user>
+```
 
-## Features
+#### Scaffold a Project
+Initialize a fresh OWD workspace:
+```bash
+pnpm desktop init [project-name]
+```
 
-- Easy setup for new Open Web Desktop projects.
-- Allows you to start development mode quickly with `npx @owdproject/cli start`.
-- Generates files for static deployment with `npx @owdproject/cli generate`.
+#### Validation
+Check Nuxt module configuration and playground directory structures:
+```bash
+pnpm desktop validate
+```
 
 ## License
 
-This project is released under the [MIT License](LICENSE).
+This package is released under the [MIT License](LICENSE).

package/bin/bridge.js

@@ -0,0 +1,129 @@
+#!/usr/bin/env node
+
+import { writeFileSync, readFileSync } from 'node:fs'
+import { join } from 'node:path'
+import {
+  findWorkspaceRoot,
+  loadSettings,
+  desktopPaths,
+  saveSettings
+} from './lib/workspace.js'
+import {
+  readDesktopConfig,
+  writeDesktopConfig,
+  readDesktopDependencies,
+  writeDesktopDependencies,
+  resolveConfigPathForWrite
+} from './lib/config.js'
+import { loadCatalog, mergeInstalled } from './lib/catalog.js'
+import { resolveDevTarget } from './lib/playgroundContext.js'
+import {
+  resolveDesktopConfigPath,
+  desktopConfigWritePath
+} from './lib/desktopConfig.js'
+
+function getWorkspaceContext() {
+  const workspaceRoot = findWorkspaceRoot()
+  if (!workspaceRoot) {
+    throw new Error('Not inside an OWD workspace')
+  }
+
+  const devTarget = resolveDevTarget(process.cwd(), workspaceRoot)
+  let paths
+  
+  if (devTarget && devTarget.mode === 'playground') {
+    const playgroundDir = devTarget.playgroundDir
+    const resolved = resolveDesktopConfigPath(playgroundDir)
+    const configWrite = desktopConfigWritePath(playgroundDir)
+    paths = {
+      desktop: playgroundDir,
+      config: resolved?.path ?? configWrite,
+      configWrite,
+      configLegacy: resolved?.legacy ?? false,
+      packageJson: join(playgroundDir, 'package.json'),
+      isPlayground: true,
+      packageName: devTarget.packageName,
+      packageDir: devTarget.packageDir,
+      metaDir: join(playgroundDir, '.desktop'),
+    }
+  } else {
+    paths = {
+      ...desktopPaths(workspaceRoot),
+      isPlayground: false,
+      metaDir: join(workspaceRoot, '.desktop'),
+    }
+  }
+
+  const settings = loadSettings(workspaceRoot, paths.metaDir)
+  
+  let config = { theme: null, apps: [], modules: [] }
+  try {
+    config = readDesktopConfig(paths.config, workspaceRoot)
+  } catch (err) {
+    console.error('Config load error:', err)
+  }
+  const deps = readDesktopDependencies(paths.packageJson)
+  return { workspaceRoot, settings, paths, config, deps }
+}
+
+async function main() {
+  const args = process.argv.slice(2)
+  const cmd = args[0]
+
+  try {
+    if (cmd === '--read') {
+      const ctx = getWorkspaceContext()
+      console.log(JSON.stringify({
+        workspaceRoot: ctx.workspaceRoot,
+        settings: ctx.settings,
+        config: ctx.config,
+        deps: ctx.deps,
+        paths: ctx.paths,
+      }, null, 2))
+    } else if (cmd === '--catalog') {
+      const ctx = getWorkspaceContext()
+      const force = args.includes('--force')
+      const catalog = await loadCatalog(ctx.workspaceRoot, ctx.settings, { force })
+      catalog.entries = mergeInstalled(catalog.entries, ctx.config, ctx.deps, ctx.workspaceRoot)
+      console.log(JSON.stringify(catalog, null, 2))
+    } else if (cmd === '--write') {
+      const ctx = getWorkspaceContext()
+      
+      // Read JSON payload from stdin
+      let input = ''
+      for await (const chunk of process.stdin) {
+        input += chunk
+      }
+      
+      const payload = JSON.parse(input)
+      // payload = { config: { theme, apps, modules }, depsToAdd: { name: version }, depsToRemove: [name], settings?: { ... } }
+      
+      if (payload.config) {
+        const configPath = resolveConfigPathForWrite(ctx.paths)
+        writeDesktopConfig(configPath, ctx.workspaceRoot, payload.config)
+      }
+      
+      if (payload.depsToAdd || payload.depsToRemove) {
+        writeDesktopDependencies(
+          ctx.paths.packageJson,
+          payload.depsToAdd || {},
+          payload.depsToRemove || []
+        )
+      }
+
+      if (payload.settings) {
+        saveSettings(ctx.workspaceRoot, payload.settings, ctx.paths.metaDir)
+      }
+      
+      console.log(JSON.stringify({ success: true }))
+    } else {
+      console.error('Usage: node bridge.js [--read|--catalog [--force]|--write]')
+      process.exit(1)
+    }
+  } catch (err) {
+    console.error(JSON.stringify({ error: err.message }))
+    process.exit(1)
+  }
+}
+
+main()