clidesk 0.1.7 → 0.1.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +113 -16
  2. package/package.json +14 -5
package/README.md CHANGED
@@ -1,40 +1,137 @@
1
- # CliDesk — npm Launcher
1
+ # CliDesk
2
2
 
3
- > Desktop app launcher for [CliDesk](https://github.com/vykelongthuong/CliDesk) — install with a single command.
3
+ [![npm version](https://img.shields.io/npm/v/clidesk.svg)](https://www.npmjs.com/package/clidesk)
4
+ [![license](https://img.shields.io/npm/l/clidesk.svg)](https://github.com/vykelongthuong/CliDesk/blob/main/LICENSE)
5
+ ![platform](https://img.shields.io/badge/platform-Windows%20x64-blue)
6
+ ![built with](https://img.shields.io/badge/built%20with-Tauri%20v2-orange)
4
7
 
5
- ## What is CliDesk?
8
+ **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.
6
9
 
7
- CliDesk is a local desktop dashboard for managing terminal sessions, files, and Git repositories — built with **Tauri v2** + **React** + **TypeScript** + **Rust**.
8
-
9
- This npm package contains the CliDesk desktop app binary and a native Windows launcher.
10
-
11
- ## Install
10
+ ## Installation
12
11
 
13
12
  ```bash
14
13
  npm i -g clidesk
15
14
  ```
16
15
 
17
- ## Usage
16
+ ## Launch
18
17
 
19
18
  ```bash
20
19
  clidesk
21
20
  ```
22
21
 
23
- The launcher copies the bundled binaries into a per-version runtime cache and opens CliDesk from there.
22
+ - `clidesk` opens the desktop app immediately.
23
+ - The terminal prompt returns right away.
24
+ - Language selection happens inside the app on first launch.
25
+ - Users can change language later in **Settings**.
26
+
27
+ ## CLI Commands
28
+
29
+ | Command | Description |
30
+ |---|---|
31
+ | `clidesk` | Open the app and return the terminal prompt immediately. |
32
+ | `clidesk --wait` | Open the app and keep the terminal attached until the app closes. Useful for debugging. |
33
+ | `clidesk --debug-launch` | Print runtime paths and launch diagnostics. |
34
+ | `clidesk --version` | Print the installed CliDesk npm package version. |
35
+ | `clidesk --update` | Update CliDesk from npm using `npm i -g clidesk@latest`. |
36
+
37
+ ## Features
38
+
39
+ - **Project-based terminal management** — organize multiple terminals per project.
40
+ - **File explorer and editor** — browse and edit project files.
41
+ - **Markdown preview** — preview `.md` files directly.
42
+ - **Manual Git panel** — view status, stage, commit, and push.
43
+ - **Vietnamese / English UI** — full i18n support.
44
+ - **Dark / Light theme** — switch anytime in Settings.
45
+ - **Local-first desktop app** — no cloud, no account required.
46
+ - **npm global launcher** — install once, run anywhere with `clidesk`.
24
47
 
25
48
  ## Requirements
26
49
 
27
50
  - **Windows x64**
51
+ - **Node.js** and **npm**
28
52
  - **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/).
29
- - **Git**, **Node.js**, and any **AI CLI tools** must be installed separately if you want to use them inside CliDesk's embedded terminals.
53
+ - **Git** — optional, needed for the Git panel.
54
+ - **AI CLI tools** (Codex CLI, Claude CLI, DeepSeek CLI, etc.) — must be installed separately by the user.
55
+
56
+ ## How It Works
57
+
58
+ 1. During `npm i -g clidesk`, the npm package includes bundled Windows binaries.
59
+ 2. When you run `clidesk`, the wrapper copies binaries to a per-version runtime cache:
60
+
61
+ ```text
62
+ %LOCALAPPDATA%\CliDesk\npm-runtime\<version>\
63
+ ```
64
+
65
+ 3. The app runs from the runtime cache, **not** directly from `node_modules`.
66
+ 4. This helps avoid Windows file-locking issues during npm update or uninstall.
67
+
68
+ ## Update
69
+
70
+ ```bash
71
+ clidesk --update
72
+ ```
73
+
74
+ Or manually:
75
+
76
+ ```bash
77
+ npm i -g clidesk@latest
78
+ ```
79
+
80
+ ## Uninstall
81
+
82
+ ```bash
83
+ npm uninstall -g clidesk
84
+ ```
85
+
86
+ ## Privacy & Security
30
87
 
31
- ## How it works
88
+ - CliDesk runs **locally** — no data is sent to external servers.
89
+ - Terminal output is **not logged** by default.
90
+ - CliDesk does **not** bundle API keys.
91
+ - External AI CLI tools are configured separately by the user.
92
+ - No administrator permission is required by default.
32
93
 
33
- 1. During `npm i -g clidesk`, the postinstall script checks that `vendor/clidesk.exe` and `vendor/clidesk-launcher.exe` are bundled.
34
- 2. When you run `clidesk`, the npm wrapper copies both binaries to `%LOCALAPPDATA%\CliDesk\npm-runtime\<version>\`.
35
- 3. The native launcher starts CliDesk from that runtime directory, not from `node_modules`.
94
+ ## Links
95
+
96
+ - **GitHub**: [github.com/vykelongthuong/CliDesk](https://github.com/vykelongthuong/CliDesk)
97
+ - **Issues**: [github.com/vykelongthuong/CliDesk/issues](https://github.com/vykelongthuong/CliDesk/issues)
98
+ - **npm**: [npmjs.com/package/clidesk](https://www.npmjs.com/package/clidesk)
99
+
100
+ ---
101
+
102
+ ## Tiếng Việt
103
+
104
+ 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.
105
+
106
+ ### Cài đặt
107
+
108
+ ```bash
109
+ npm i -g clidesk
110
+ ```
111
+
112
+ ### Chạy
113
+
114
+ ```bash
115
+ clidesk
116
+ ```
117
+
118
+ - Lệnh `clidesk` sẽ mở app và trả terminal về prompt ngay.
119
+ - Chọn ngôn ngữ trong app ở lần chạy đầu tiên.
120
+ - Có thể đổi ngôn ngữ trong **Cài đặt**.
121
+
122
+ ### Cập nhật
123
+
124
+ ```bash
125
+ clidesk --update
126
+ ```
127
+
128
+ Hoặc:
129
+
130
+ ```bash
131
+ npm i -g clidesk@latest
132
+ ```
36
133
 
37
- The CliDesk desktop app itself is a Tauri application built from the [source repository](https://github.com/vykelongthuong/CliDesk).
134
+ ---
38
135
 
39
136
  ## License
40
137
 
package/package.json CHANGED
@@ -1,12 +1,16 @@
1
1
  {
2
2
  "name": "clidesk",
3
- "version": "0.1.7",
4
- "description": "CliDesk desktop app launcher — install with npm i -g clidesk",
3
+ "version": "0.1.8",
4
+ "description": "Local desktop dashboard for project-based terminals and AI coding CLI tools.",
5
5
  "license": "Apache-2.0",
6
+ "homepage": "https://github.com/vykelongthuong/CliDesk#readme",
6
7
  "repository": {
7
8
  "type": "git",
8
9
  "url": "git+https://github.com/vykelongthuong/CliDesk.git"
9
10
  },
11
+ "bugs": {
12
+ "url": "https://github.com/vykelongthuong/CliDesk/issues"
13
+ },
10
14
  "bin": {
11
15
  "clidesk": "bin/clidesk.js"
12
16
  },
@@ -27,9 +31,14 @@
27
31
  ],
28
32
  "keywords": [
29
33
  "clidesk",
30
- "desktop",
31
- "dashboard",
32
34
  "terminal",
33
- "tauri"
35
+ "terminal-dashboard",
36
+ "ai-cli",
37
+ "coding-agent",
38
+ "developer-tools",
39
+ "tauri",
40
+ "xterm",
41
+ "git",
42
+ "desktop-app"
34
43
  ]
35
44
  }