dsh-remote 0.5.4 → 0.5.6

package/README.md

@@ -4,6 +4,10 @@
 
 # dsh-remote
 
+[![npm version](https://img.shields.io/npm/v/dsh-remote)](https://www.npmjs.com/package/dsh-remote)
+[![license](https://img.shields.io/github/license/flymysql/dsh-remote)](LICENSE)
+[![dsh-plugin](https://img.shields.io/badge/topic-dsh--plugin-7a3ef3)](https://github.com/topics/dsh-plugin)
+
 **Remote-work assistant for [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) (DSH).**
 
 Manage several SSH machines, then pick a **remote workspace** (or a **local** one) and let the agent operate right there without leaving the harness — listing files, reading code, running builds & commands over the remote host, and keeping that remote directory mirrored into a real local workspace object.
@@ -14,7 +18,7 @@ The harness Web UI intentionally binds `127.0.0.1` (the CLI rejects `--host 0.0.
 
 Settings → **远程工作区** — a multi-machine SSH registry (add / edit / delete / set-current, password stored locally):
 
-<img src="https://raw.githubusercontent.com/flymysql/dsh-remote/main/docs/ui-settings.svg" alt="dsh-remote settings — multi-machine registry" width="720"/>
+<img src="https://cdn.jsdelivr.net/gh/flymysql/dsh-remote@main/docs/ui-settings-panel.png" alt="dsh-remote settings — multi-machine registry (light theme, host scrubbed)" width="720"/>
 
 The native **"Add workspace" / "Select workspace"** flow — a centered modal, two tabs, opens on **本机 (local)**; switch to **远程 (remote)**:
 
@@ -22,7 +26,7 @@ The native **"Add workspace" / "Select workspace"** flow — a centered modal, t
 
 Real capture (host scrubbed to a placeholder):
 
-<img src="https://raw.githubusercontent.com/flymysql/dsh-remote/main/docs/ui-picker-panel.png" alt="dsh-remote workspace picker — real dialog; 本机 (local) tab; 远程 machine select + prefilled root path + autocomplete" width="720"/>
+<img src="https://cdn.jsdelivr.net/gh/flymysql/dsh-remote@main/docs/ui-picker-panel.png" alt="dsh-remote workspace picker — real dialog; 本机 (local) tab; 远程 machine select + prefilled root path + autocomplete" width="720"/>
 
 ---
 
@@ -122,4 +126,8 @@ Giving the plugin a machine's credentials lets the agent run **shell commands as
 
 ## License
 
-MIT
+MIT
+
+## Changelog
+
+See [CHANGELOG.md](./CHANGELOG.md).

package/README.zh.md

@@ -4,6 +4,10 @@
 
 # dsh-remote
 
+[![npm version](https://img.shields.io/npm/v/dsh-remote)](https://www.npmjs.com/package/dsh-remote)
+[![license](https://img.shields.io/github/license/flymysql/dsh-remote)](LICENSE)
+[![dsh-plugin](https://img.shields.io/badge/topic-dsh--plugin-7a)](https://github.com/topics/dsh-plugin)
+
 **为 [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness)（DSH）打造的远程工作助手。**
 
 维护多台 SSH 机器，然后在「选择工作区」时选一个**远程工作区**（或**本地工作区**），Agent 就能在不离开 harness 的情况下直接操作——列文件、读代码、在远程主机上跑构建/命令，并把远程目录镜像成一个真实的本地工作区对象。
@@ -14,7 +18,7 @@ DSH 的 Web 界面刻意只监听 `127.0.0.1`（CLI 为安全拒绝 `--host 0.0.
 
 设置 → **远程工作区** —— 多机 SSH 列表（增/删/改/设为当前，密码本地保存、不回显）：
 
-<img src="https://raw.githubusercontent.com/flymysql/dsh-remote/main/docs/ui-settings.svg" alt="dsh-remote 设置页 — 多机列表" width="720"/>
+<img src="https://cdn.jsdelivr.net/gh/flymysql/dsh-remote@main/docs/ui-settings-panel.png" alt="dsh-remote 设置页 — 多机列表（浅色主题，主机已打码）" width="720"/>
 
 原生 **「Add workspace / 选择工作区」** 流程 —— **居中弹窗**、两个 tab，**默认落在「本机」**；切到 **「远程」**：
 
@@ -22,7 +26,7 @@ DSH 的 Web 界面刻意只监听 `127.0.0.1`（CLI 为安全拒绝 `--host 0.0.
 
 真实截图（机器已打码为占位）：
 
-<img src="https://raw.githubusercontent.com/flymysql/dsh-remote/main/docs/ui-picker-panel.png" alt="dsh-remote 工作区选择 — 真实弹窗；默认本机 tab；远程：机器下拉 + 预填根路径 + 自动补全" width="720"/>
+<img src="https://cdn.jsdelivr.net/gh/flymysql/dsh-remote@main/docs/ui-picker-panel.png" alt="dsh-remote 工作区选择 — 真实弹窗；默认本机 tab；远程：机器下拉 + 预填根路径 + 自动补全" width="720"/>
 
 ---
 
@@ -123,4 +127,8 @@ npx --yes @deepseek-ai/dsh plugin --profile web remove dsh-remote   # 恢复用
 
 ## License
 
-MIT
+MIT
+
+## 变更记录
+
+见 [CHANGELOG.md](./CHANGELOG.md)。

package/lib/index.js

@@ -41,7 +41,7 @@ export const Config = z.object({
   username: z.string().default(''),
   /** Password login (only when the remote has no key. Override the fallback below). */
   password: z.string().default(''),
-  /** Absolute private-key path; empty → ~/.ssh/id_rsa. */
+  /** Explicit SSH private-key path (optional; only used when supplied). Never auto-reads ~/.ssh. */
   privateKeyPath: z.string().default(''),
   /** Key passphrase when the key is encrypted. */
   passphrase: z.string().default(''),
@@ -236,7 +236,7 @@ class SshPool {
 
   resolveKeyPath() {
     const p = this.config.privateKeyPath
-    if (!p) return path.join(homedir(), '.ssh', 'id_rsa')
+    if (!p) return ''
     if (p.startsWith('~/') || p === '~') return path.join(homedir(), p.slice(1))
     return p
   }
@@ -296,13 +296,15 @@ class SshPool {
       if (this.config.password) {
         opts.password = this.config.password
       } else {
+        const keyPath = this.resolveKeyPath()
+        if (!keyPath) {
+          return fail(new Error('no credentials: set a password or a privateKeyPath to connect'))
+        }
         let key
         try {
-          key = readFileSync(this.resolveKeyPath())
+          key = readFileSync(keyPath)
         } catch (err) {
-          return fail(
-            new Error(`cannot read private key "${this.resolveKeyPath()}": ${err && err.message}`),
-          )
+          return fail(new Error(`cannot read private key "${keyPath}": ${err && err.message}`))
         }
         opts.privateKey = key
         opts.passphrase = this.config.passphrase || undefined
@@ -496,7 +498,7 @@ export async function apply(ctx, config) {
         'Show the remote environment: host/user/port, connection health, and the current remote workspace path. Call this first to orient, or when a remote_* call fails to check connectivity.',
       parameters: {},
       output: {
-        schema: { type: 'object', additionalProperties: false, properties: { text: { type: 'string', required: true } } },
+        schema: { type: 'object', additionalProperties: false, required: ['text'], properties: { text: { type: 'string' } } },
         render: (_a, v) => [{ type: 'text', text: v.text }],
       },
       async execute() {
@@ -528,14 +530,15 @@ export async function apply(ctx, config) {
       description:
         'Connect SSH to a remote host for remote workspace work. Provide host (required), user, optional password or privateKeyPath/port. Once connected, call rw_pick_workspace to pick the workspace directory this session should work in.',
       parameters: {
-        host: { type: 'string', required: true, description: 'Remote host IP or hostname' },
+        required: ['host'],
+        host: { type: 'string', description: 'Remote host IP or hostname' },
         username: { type: 'string', description: 'SSH user (default from config or root)' },
         port: { type: 'integer', description: 'SSH port (default 22)' },
         password: { type: 'string', description: 'SSH password (prefer SSH key when possible)' },
         privateKeyPath: { type: 'string', description: 'Absolute private-key path' },
       },
       output: {
-        schema: { type: 'object', additionalProperties: false, properties: { text: { type: 'string', required: true } } },
+        schema: { type: 'object', additionalProperties: false, required: ['text'], properties: { text: { type: 'string' } } },
         render: (_a, a) => [{ type: 'text', text: a.text }],
       },
       async execute(args) {
@@ -563,10 +566,11 @@ export async function apply(ctx, config) {
       description:
         'Set the remote workspace directory this session should treat as its working root on the connected remote. Verifies it exists (a directory). Use rw_list_dir to browse first if unsure.',
       parameters: {
-        path: { type: 'string', required: true, description: 'Absolute remote directory path, e.g. /home/dev/code/project' },
+        required: ['path'],
+        path: { type: 'string', description: 'Absolute remote directory path, e.g. /home/dev/code/project' },
       },
       output: {
-        schema: { type: 'object', additionalProperties: false, properties: { text: { type: 'string', required: true } } },
+        schema: { type: 'object', additionalProperties: false, required: ['text'], properties: { text: { type: 'string' } } },
         render: (_a, a) => [{ type: 'text', text: a.text }],
       },
       async execute(args) {
@@ -592,7 +596,7 @@ export async function apply(ctx, config) {
         maxFiles: { type: 'integer', description: 'Max files to download (default 500)' },
       },
       output: {
-        schema: { type: 'object', additionalProperties: false, properties: { text: { type: 'string', required: true } } },
+        schema: { type: 'object', additionalProperties: false, required: ['text'], properties: { text: { type: 'string' } } },
         render: (_a, a) => [{ type: 'text', text: a.text }],
       },
       async execute(args) {
@@ -621,7 +625,7 @@ export async function apply(ctx, config) {
         maxFiles: { type: 'integer', description: 'Max files to upload (default 500)' },
       },
       output: {
-        schema: { type: 'object', additionalProperties: false, properties: { text: { type: 'string', required: true } } },
+        schema: { type: 'object', additionalProperties: false, required: ['text'], properties: { text: { type: 'string' } } },
         render: (_a, a) => [{ type: 'text', text: a.text }],
       },
       async execute(args) {
@@ -649,7 +653,7 @@ export async function apply(ctx, config) {
         path: { type: 'string', description: 'Absolute remote path (default: current remote workspace)' },
       },
       output: {
-        schema: { type: 'object', additionalProperties: false, properties: { text: { type: 'string', required: true } } },
+        schema: { type: 'object', additionalProperties: false, required: ['text'], properties: { text: { type: 'string' } } },
         render: (_a, a) => [{ type: 'text', text: a.text }],
       },
       async execute(args) {
@@ -664,13 +668,14 @@ export async function apply(ctx, config) {
       description:
         'Read a text file on the remote host with line numbers. Supports paging with startLine/endLine. Path is absolute.', 
       parameters: {
-        path: { type: 'string', required: true, description: 'Absolute remote file path' },
+        required: ['path'],
+        path: { type: 'string', description: 'Absolute remote file path' },
         startLine: { type: 'integer', description: '1-based first line (default 1)' },
         endLine: { type: 'integer', description: '1-based last line (inclusive)' },
         maxLines: { type: 'integer', description: 'Max lines (default 2000)' },
       },
       output: {
-        schema: { type: 'object', additionalProperties: false, properties: { text: { type: 'string', required: true } } },
+        schema: { type: 'object', additionalProperties: false, required: ['text'], properties: { text: { type: 'string' } } },
         render: (_a, a) => [{ type: 'text', text: a.text }],
       },
       async execute(args) {
@@ -693,10 +698,11 @@ export async function apply(ctx, config) {
       description:
         'Run a shell command on the remote host. Use for anything that is not reading a file (build, test, grep, etc). Output is capped.',
       parameters: {
-        command: { type: 'string', required: true, description: 'Shell command (run on the remote host)' },
+        required: ['command'],
+        command: { type: 'string', description: 'Shell command (run on the remote host)' },
       },
       output: {
-        schema: { type: 'object', additionalProperties: false, properties: { text: { type: 'string', required: true } } },
+        schema: { type: 'object', additionalProperties: false, required: ['text'], properties: { text: { type: 'string' } } },
         render: (_a, a) => [{ type: 'text', text: a.text }],
       },
       async execute(args) {
@@ -711,12 +717,13 @@ export async function apply(ctx, config) {
       description:
         'Write text to a file on the remote host (creating parent directories if needed). Path is absolute. Use this to create or overwrite a remote file directly, instead of round-tripping through a local mirror.',
       parameters: {
-        path: { type: 'string', required: true, description: 'Absolute remote file path' },
-        content: { type: 'string', required: true, description: 'File content to write (overwrites existing file)' },
+        required: ['path', 'content'],
+        path: { type: 'string', description: 'Absolute remote file path' },
+        content: { type: 'string', description: 'File content to write (overwrites existing file)' },
         mkdir: { type: 'boolean', description: 'Create missing parent directories (default true)' },
       },
       output: {
-        schema: { type: 'object', additionalProperties: false, properties: { ok: { type: 'boolean', required: true }, bytes: { type: 'integer' }, text: { type: 'string' } } },
+        schema: { type: 'object', additionalProperties: false, required: ['ok'], properties: { ok: { type: 'boolean' }, bytes: { type: 'integer' }, text: { type: 'string' } } },
         render: (_a, a) => [{ type: 'text', text: a.text || (a.ok ? 'written' : 'failed') }],
       },
       async execute(args) {
@@ -754,7 +761,7 @@ export async function apply(ctx, config) {
         'Close the current SSH connection to the remote host, releasing the persistent pool. Useful to rotate connections or after a long idle.',
       parameters: {},
       output: {
-        schema: { type: 'object', additionalProperties: false, properties: { ok: { type: 'boolean', required: true }, text: { type: 'string' } } },
+        schema: { type: 'object', additionalProperties: false, required: ['ok'], properties: { ok: { type: 'boolean' }, text: { type: 'string' } } },
         render: (_a, a) => [{ type: 'text', text: a.text }],
       },
       async execute() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-remote",
-  "version": "0.5.4",
+  "version": "0.5.6",
   "description": "Remote-work assistant for DeepSeek Harness: connect SSH (password or key), pick a remote workspace, operate on it with rw_pick_workspace / rw_list_dir / rw_read_file / rw_exec / rw_sync tools, and mirror it to a real local directory (SFTP) so the DSH native workspace can adopt it.",
   "license": "MIT",
   "author": "flymysql <flyphp@outlook.com>",