clidesk 0.1.6 → 0.1.8

package/README.md

@@ -1,40 +1,137 @@
-# CliDesk — npm Launcher
+# CliDesk
 
-> Desktop app launcher for [CliDesk](https://github.com/vykelongthuong/CliDesk) — install with a single command.
+[![npm version](https://img.shields.io/npm/v/clidesk.svg)](https://www.npmjs.com/package/clidesk)
+[![license](https://img.shields.io/npm/l/clidesk.svg)](https://github.com/vykelongthuong/CliDesk/blob/main/LICENSE)
+![platform](https://img.shields.io/badge/platform-Windows%20x64-blue)
+![built with](https://img.shields.io/badge/built%20with-Tauri%20v2-orange)
 
-## What is CliDesk?
+**A local desktop dashboard for managing project-based terminals, files, Git status, and AI coding CLI tools** such as Codex CLI, Claude CLI, DeepSeek CLI, and other terminal-based developer agents.
 
-CliDesk is a local desktop dashboard for managing terminal sessions, files, and Git repositories — built with **Tauri v2** + **React** + **TypeScript** + **Rust**.
-
-This npm package contains the CliDesk desktop app binary and a native Windows launcher.
-
-## Install
+## Installation
 
 ```bash
 npm i -g clidesk
 ```
 
-## Usage
+## Launch
 
 ```bash
 clidesk
 ```
 
-The launcher copies the bundled binaries into a per-version runtime cache and opens CliDesk from there.
+- `clidesk` opens the desktop app immediately.
+- The terminal prompt returns right away.
+- Language selection happens inside the app on first launch.
+- Users can change language later in **Settings**.
+
+## CLI Commands
+
+| Command | Description |
+|---|---|
+| `clidesk` | Open the app and return the terminal prompt immediately. |
+| `clidesk --wait` | Open the app and keep the terminal attached until the app closes. Useful for debugging. |
+| `clidesk --debug-launch` | Print runtime paths and launch diagnostics. |
+| `clidesk --version` | Print the installed CliDesk npm package version. |
+| `clidesk --update` | Update CliDesk from npm using `npm i -g clidesk@latest`. |
+
+## Features
+
+- **Project-based terminal management** — organize multiple terminals per project.
+- **File explorer and editor** — browse and edit project files.
+- **Markdown preview** — preview `.md` files directly.
+- **Manual Git panel** — view status, stage, commit, and push.
+- **Vietnamese / English UI** — full i18n support.
+- **Dark / Light theme** — switch anytime in Settings.
+- **Local-first desktop app** — no cloud, no account required.
+- **npm global launcher** — install once, run anywhere with `clidesk`.
 
 ## Requirements
 
 - **Windows x64**
+- **Node.js** and **npm**
 - **Microsoft Edge WebView2 Runtime** — pre-installed on Windows 11 and Windows 10 (April 2018+). If missing, [download here](https://developer.microsoft.com/en-us/microsoft-edge/webview2/).
-- **Git**, **Node.js**, and any **AI CLI tools** must be installed separately if you want to use them inside CliDesk's embedded terminals.
+- **Git** — optional, needed for the Git panel.
+- **AI CLI tools** (Codex CLI, Claude CLI, DeepSeek CLI, etc.) — must be installed separately by the user.
+
+## How It Works
+
+1. During `npm i -g clidesk`, the npm package includes bundled Windows binaries.
+2. When you run `clidesk`, the wrapper copies binaries to a per-version runtime cache:
+
+   ```text
+   %LOCALAPPDATA%\CliDesk\npm-runtime\<version>\
+   ```
+
+3. The app runs from the runtime cache, **not** directly from `node_modules`.
+4. This helps avoid Windows file-locking issues during npm update or uninstall.
+
+## Update
+
+```bash
+clidesk --update
+```
+
+Or manually:
+
+```bash
+npm i -g clidesk@latest
+```
+
+## Uninstall
+
+```bash
+npm uninstall -g clidesk
+```
+
+## Privacy & Security
 
-## How it works
+- CliDesk runs **locally** — no data is sent to external servers.
+- Terminal output is **not logged** by default.
+- CliDesk does **not** bundle API keys.
+- External AI CLI tools are configured separately by the user.
+- No administrator permission is required by default.
 
-1. During `npm i -g clidesk`, the postinstall script checks that `vendor/clidesk.exe` and `vendor/clidesk-launcher.exe` are bundled.
-2. When you run `clidesk`, the npm wrapper copies both binaries to `%LOCALAPPDATA%\CliDesk\npm-runtime\<version>\`.
-3. The native launcher starts CliDesk from that runtime directory, not from `node_modules`.
+## Links
+
+- **GitHub**: [github.com/vykelongthuong/CliDesk](https://github.com/vykelongthuong/CliDesk)
+- **Issues**: [github.com/vykelongthuong/CliDesk/issues](https://github.com/vykelongthuong/CliDesk/issues)
+- **npm**: [npmjs.com/package/clidesk](https://www.npmjs.com/package/clidesk)
+
+---
+
+## Tiếng Việt
+
+CliDesk là ứng dụng desktop local để quản lý nhiều terminal theo project, tích hợp trình quản lý file, Git, và hỗ trợ các AI coding CLI tool.
+
+### Cài đặt
+
+```bash
+npm i -g clidesk
+```
+
+### Chạy
+
+```bash
+clidesk
+```
+
+- Lệnh `clidesk` sẽ mở app và trả terminal về prompt ngay.
+- Chọn ngôn ngữ trong app ở lần chạy đầu tiên.
+- Có thể đổi ngôn ngữ trong **Cài đặt**.
+
+### Cập nhật
+
+```bash
+clidesk --update
+```
+
+Hoặc:
+
+```bash
+npm i -g clidesk@latest
+```
 
-The CliDesk desktop app itself is a Tauri application built from the [source repository](https://github.com/vykelongthuong/CliDesk).
+---
 
 ## License
 

package/bin/clidesk.js

@@ -1,6 +1,17 @@
 #!/usr/bin/env node
 // CliDesk npm launcher.
 //
+// Default flow (clidesk):
+//   - Copy binaries to runtime cache
+//   - Spawn clidesk.exe directly (detached)
+//   - Return terminal prompt immediately
+//   - No terminal menu, no launcher interactive
+//
+// --wait:      Use native launcher with --no-menu, keep terminal attached
+// --debug-launch: Print debug info then launch app
+// --version:   Print npm package version
+// --update:    Run npm i -g clidesk@latest
+//
 // The package stores signed binaries in vendor/, but it never runs them from
 // node_modules. Each package version is copied to a runtime cache first so npm
 // can update or uninstall the global package without Windows keeping vendor/
@@ -8,10 +19,10 @@
 
 const fs = require('fs');
 const path = require('path');
-const { execFileSync, spawn } = require('child_process');
+const { execFileSync, spawn, execSync } = require('child_process');
 
 const args = process.argv.slice(2);
-const debug = args.includes('--debug-launch');
+const hasFlag = (flag) => args.includes(flag);
 
 const packageRoot = path.resolve(__dirname, '..');
 const pkg = require(path.join(packageRoot, 'package.json'));
@@ -32,8 +43,8 @@ const vendorLauncher = path.join(vendorDir, 'clidesk-launcher.exe');
 
 const runtimeApp = path.join(runtimeDir, 'clidesk.exe');
 const runtimeLauncher = path.join(runtimeDir, 'clidesk-launcher.exe');
-const latestVersion = readLatestVersion();
-const updateAvailable = latestVersion ? isVersionNewer(latestVersion, version) : false;
+
+// ── Helpers ────────────────────────────────────────────────────
 
 function ensureFileExists(filePath, label) {
     if (!fs.existsSync(filePath)) {
@@ -65,16 +76,7 @@ function copyIfMissing(src, dest) {
     }
 }
 
-function printDebugInfo() {
-    console.log('[CliDesk] packageRoot:', packageRoot);
-    console.log('[CliDesk] vendorDir:', vendorDir);
-    console.log('[CliDesk] runtimeDir:', runtimeDir);
-    console.log('[CliDesk] launcherPath:', runtimeLauncher);
-    console.log('[CliDesk] appPath:', runtimeApp);
-    console.log('[CliDesk] version:', version);
-    console.log('[CliDesk] latestVersion:', latestVersion || '(unknown)');
-    console.log('[CliDesk] updateAvailable:', updateAvailable ? 'true' : 'false');
-}
+// ── Version helpers ────────────────────────────────────────────
 
 function readLatestVersion() {
     try {
@@ -134,22 +136,69 @@ function parseVersion(value) {
     return parts;
 }
 
-function main() {
-    copyIfMissing(vendorApp, runtimeApp);
-    copyIfMissing(vendorLauncher, runtimeLauncher);
+// ── Actions ────────────────────────────────────────────────────
+
+function actionVersion() {
+    console.log(version);
+    process.exit(0);
+}
 
-    if (debug) {
-        printDebugInfo();
+function actionUpdate() {
+    console.log('[CliDesk] Cập nhật clidesk từ npm...');
+    try {
+        execSync('npm i -g clidesk@latest', {
+            stdio: 'inherit',
+            windowsHide: true,
+        });
+        console.log('[CliDesk] Cập nhật hoàn tất. Chạy clidesk để dùng bản mới.');
+    } catch (err) {
+        console.error('[CliDesk] Cập nhật thất bại.');
+        console.error(err.message || err);
+        process.exit(1);
     }
+}
+
+function printDebugInfo() {
+    const latestVersion = readLatestVersion();
+    const updateAvailable = latestVersion ? isVersionNewer(latestVersion, version) : false;
+
+    console.log('[CliDesk] packageRoot:', packageRoot);
+    console.log('[CliDesk] vendorDir:', vendorDir);
+    console.log('[CliDesk] runtimeDir:', runtimeDir);
+    console.log('[CliDesk] launcherPath:', runtimeLauncher);
+    console.log('[CliDesk] appPath:', runtimeApp);
+    console.log('[CliDesk] version:', version);
+    console.log('[CliDesk] latestVersion:', latestVersion || '(unknown)');
+    console.log('[CliDesk] updateAvailable:', updateAvailable ? 'true' : 'false');
+}
 
-    const child = spawn(runtimeLauncher, args, {
+function actionDebugLaunch() {
+    printDebugInfo();
+    // After debug info, launch app directly (detached) so terminal is free
+    console.log('[CliDesk] Khởi động CliDesk...');
+    const child = spawn(runtimeApp, [], {
         cwd: runtimeDir,
         env: {
             ...process.env,
             CLIDESK_VERSION: version,
-            CLIDESK_LATEST_VERSION: latestVersion || '',
-            CLIDESK_UPDATE_AVAILABLE: updateAvailable ? '1' : '0',
-            CLIDESK_UPDATE_COMMAND: 'npm i -g clidesk',
+            CLIDESK_LAUNCH_LANG: '',
+        },
+        detached: true,
+        stdio: 'ignore',
+        windowsHide: true,
+    });
+    child.unref();
+    process.exit(0);
+}
+
+function actionWait() {
+    // Use native launcher with --no-menu flag for Job Object lifecycle
+    const child = spawn(runtimeLauncher, ['--no-menu'], {
+        cwd: runtimeDir,
+        env: {
+            ...process.env,
+            CLIDESK_VERSION: version,
+            CLIDESK_LAUNCH_LANG: '',
         },
         stdio: 'inherit',
         windowsHide: false,
@@ -161,18 +210,68 @@ function main() {
 
     child.on('error', (err) => {
         console.error('[CliDesk] Không thể chạy launcher:', err.message);
-        console.error('[CliDesk] Path:', runtimeLauncher);
         process.exit(1);
     });
 }
 
+function actionDefault() {
+    // Copy binaries to runtime cache
+    copyIfMissing(vendorApp, runtimeApp);
+    copyIfMissing(vendorLauncher, runtimeLauncher);
+
+    // Spawn app directly (detached), no launcher, no terminal menu
+    const child = spawn(runtimeApp, [], {
+        cwd: runtimeDir,
+        env: {
+            ...process.env,
+            CLIDESK_VERSION: version,
+            CLIDESK_LAUNCH_LANG: '',
+        },
+        detached: true,
+        stdio: 'ignore',
+        windowsHide: true,
+    });
+    child.unref();
+    process.exit(0);
+}
+
+// ── Main ───────────────────────────────────────────────────────
+
+function main() {
+    // Handle flags that don't need binaries
+    if (hasFlag('--version') || hasFlag('-v')) {
+        actionVersion();
+    }
+
+    if (hasFlag('--update')) {
+        actionUpdate();
+    }
+
+    // Ensure binaries exist in runtime cache
+    try {
+        copyIfMissing(vendorApp, runtimeApp);
+        copyIfMissing(vendorLauncher, runtimeLauncher);
+    } catch (err) {
+        console.error('[CliDesk] Không thể chuẩn bị runtime CliDesk.');
+        console.error('[CliDesk] Lỗi:', err && err.message ? err.message : err);
+        process.exit(1);
+    }
+
+    if (hasFlag('--debug-launch')) {
+        actionDebugLaunch();
+    }
+
+    if (hasFlag('--wait')) {
+        actionWait();
+    }
+
+    // Default: launch app detached, return prompt immediately
+    actionDefault();
+}
+
 try {
     main();
 } catch (err) {
-    console.error('[CliDesk] Không thể chuẩn bị runtime CliDesk.');
-    console.error('[CliDesk] Lỗi:', err && err.message ? err.message : err);
-    if (debug) {
-        printDebugInfo();
-    }
+    console.error('[CliDesk] Lỗi không xác định:', err && err.message ? err.message : err);
     process.exit(1);
 }

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "clidesk",
-  "version": "0.1.6",
-  "description": "CliDesk desktop app launcher — install with npm i -g clidesk",
+  "version": "0.1.8",
+  "description": "Local desktop dashboard for project-based terminals and AI coding CLI tools.",
   "license": "Apache-2.0",
+  "homepage": "https://github.com/vykelongthuong/CliDesk#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vykelongthuong/CliDesk.git"
   },
+  "bugs": {
+    "url": "https://github.com/vykelongthuong/CliDesk/issues"
+  },
   "bin": {
     "clidesk": "bin/clidesk.js"
   },
@@ -27,9 +31,14 @@
   ],
   "keywords": [
     "clidesk",
-    "desktop",
-    "dashboard",
     "terminal",
-    "tauri"
+    "terminal-dashboard",
+    "ai-cli",
+    "coding-agent",
+    "developer-tools",
+    "tauri",
+    "xterm",
+    "git",
+    "desktop-app"
   ]
 }