dsh-remote-local-plugin 0.0.0-stage → 0.8.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 dsh-remote contributors
+
+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,3 +1,86 @@
-# Temporary Holding Version
+# dsh-remote-local-plugin
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Remote development that appears as ordinary local sessions.
+
+## What it does
+
+- Durable host registry at `$DSH_HOME/remote/hosts.json` (mode `0600`).
+- SSH discovery of the remote agent's private state file.
+- **Plugin-owned provisioning**: uploads the bundled `dsh-remote-agent` tarball, installs pnpm/DSH
+  when missing, starts remote `dsh web`, waits for it, and connects. No separate installer command.
+- One loopback SSH tunnel per host, health checks, exponential backoff, manual reconnect.
+- Default direct key mode: the resolved local key is copied into the remote service environment.
+- Optional reverse SSH forward and **local model credential proxy** for key-local deployments.
+- **Native session mirror**: remote workspaces/sessions become local workspaces and Sessions in the
+  ordinary sidebar. A small custom Agent façade routes prompts and cancellation to the remote agent
+  while the normal Conversation UI renders the mirrored events.
+- `+ 新会话` creates the remote session, creates its local mirror, and opens it through
+  `uiWorkspace.openSession` — not a popup.
+- Sidebar **+** menu to create a workspace locally (native flow) or on a connected remote host.
+- SSH-backed remote workspace file listing/preview.
+- Automatic remote Node.js discovery/install (nvm, Volta, fnm, Bun, asdf, mise, Nix, Homebrew, login shell; verified Node tarball fallback).
+- Chinese / English client copy follows the DSH locale service.
+- Remote SSH PTY terminals for mirror Sessions; local Sessions keep the local terminal.
+- Remote approval questions bridged into the normal local approval UI.
+- Model tools for every operation.
+- Authenticated host API at `/api/dsh-remote` through DSH Connection's Fetch route.
+
+## Install
+
+### From the DSH plugin page
+
+After the npm package is published, use **Plugins → Add plugin** and enter:
+
+```text
+dsh-remote-local-plugin
+```
+
+The package bundles the remote agent asset and the terminal-controller fork. Restart DSH after the
+plugin page asks for it.
+
+### From a source checkout
+
+```sh
+cd ../..
+./scripts/install-local.sh          # desktop profile
+./scripts/install-local.sh --profile web
+```
+
+The installer creates one tarball containing the terminal-controller fork; restart DSH after it
+finishes.
+
+## Use
+
+1. **Settings → 远程开发**
+2. Enter an SSH target (`my-host`) and click **保存并连接**.
+3. Wait for `已连接` (first use installs the remote side).
+4. Use **Workspaces +** to create a workspace; local folders use the native picker, remote folders
+   use the SSH browser.
+5. Create a session from the workspace row or Settings. The mirrored session opens in the normal
+   Conversation UI.
+6. Continue prompting. **Workspace files** and **New terminal** follow the selected Session.
+
+## Boundaries
+
+- The remote browser UI is intentionally not exposed by default; the remote API-remotes carrier is
+  disabled so approvals reach the native local UI.
+- Sessions over `mirrorMaxEvents` are not mirrored.
+- On plugin restart, old mirrors are archived and recreated.
+
+## Tools
+
+`remote_hosts_list`, `remote_host_add`, `remote_host_connect`, `remote_host_provision`,
+`remote_workspace_add`, `remote_workspaces_list`, `remote_session_create`, `remote_sessions_list`,
+`remote_session_prompt`, `remote_session_snapshot`, `remote_session_cancel`.
+
+## Configuration
+
+See [`cordis.patch.yml`](cordis.patch.yml) and
+[`examples/local-plugin.patch.yml`](../../examples/local-plugin.patch.yml).
+
+## Security
+
+The token stays local and is never returned to the browser. The browser uses DSH's authenticated
+`/api` route. By default the model key is written to the remote service environment; set
+`credentialProxy: true` to keep it local and inject it through the reverse-tunnel proxy. See the
+[root README](../../README.md#security).

package/cordis.patch.yml

@@ -0,0 +1,50 @@
+# dsh-remote-local-plugin host bundle.
+#
+# One row owns the host registry, SSH tunnels, plugin-owned remote
+# provisioning, the local model credential proxy, and the authenticated host
+# API. Its browser half registers the Settings page and remote chat drawer.
+# The terminal-controller fork is bundled with this package; this patch disables
+# the stock row and mounts the fork so mirrored Sessions use SSH PTYs.
+- id: terminal-controller
+  disabled: true
+- insert:
+    - id: terminal-controller-remote
+      name: dsh-remote-terminal-controller
+    - id: dsh-remote-local
+      name: dsh-remote-local-plugin
+      config:
+        # Empty means $DSH_HOME/remote.
+        stateDir: ''
+        sshBinary: ssh
+        # Empty means <remoteDshHome>/remote-agent/agent.json.
+        remoteStateFile: ''
+        probeTimeoutMs: 10000
+        connectTimeoutMs: 15000
+        healthIntervalMs: 15000
+        reconnect: true
+        maxReconnectDelayMs: 30000
+        strictHostKeyChecking: accept-new
+
+        # One-click remote provisioning.
+        autoProvision: true
+        remoteDshHome: ~/.dsh
+        remoteInstallDir: ~/.local/share/dsh-remote
+        remoteDshVersion: 0.2.1-rc.2
+        remotePnpmVersion: 11.21.0
+        remoteStart: systemd
+        provisionTimeoutMs: 600000
+
+        # Default: copy the locally resolved key into the remote service env.
+        credentialProxy: false
+        copyModelKey: true
+        remoteModelBaseUrl: https://api.deepseek.com/anthropic
+
+        # Optional: keep the key local and proxy through a reverse SSH tunnel.
+        credentialProxyUpstream: https://api.deepseek.com/anthropic
+        credentialProxyRemotePort: 47821
+        modelCredentialRef: DEEPSEEK_API_KEY
+
+        # Mirror remote workspaces/sessions into the ordinary local UI.
+        mirrorSessions: true
+        mirrorPollMs: 1500
+        mirrorMaxEvents: 2000