README.md 3.6 KB
description: "Remote filesystem semantics for consumers sharing files with SSH subprocesses."
kind: "package-reference"
@deepseek-ai/dsh-fs-ssh
English | 中文
Summary
dsh-fs-ssh provides ctx.fs in the SSH helper’s filesystem. File tools read and mutate the same files that remote Bash, terminals, language servers and Node programs see. Remote canonicalization, version guards and atomic mutations use the local filesystem implementations installed beside the helper.
Table of Contents
- Use this package
- Understand the implementation
- Further Exploration
- Model Experience
- Known Limitations and Deferred Work
- Dev Note
Use this package
Mount this provider with dsh-ssh and sandboxPolicy; use its paired SSH subprocess and sandbox providers for execution. This provider has no configuration fields: connection identity and the default workspace belong to dsh-ssh, while file-effect mode belongs to sandboxPolicy.
resolve() canonicalizes paths on the remote host. processPath() and fileUrl() name files in that same remote namespace; they do not grant host-side access. File URLs encode literal percent signs, backslashes and newlines without changing the filename. processPathFromHostPath() returns undefined, so consumers requiring an installed executable or bootstrap must supply a remote artifact explicitly.
Reads preserve the shared filesystem error codes. Writes and edits send the resolved per-call policy to the helper, which canonicalizes the workspace and enforces it beside the atomic mutation. Lost transport reports an I/O failure; a mutation may already have committed and is not retried automatically.
Understand the implementation
Implementation internals — click to expand
The helper reuses [`fs-local`](../../fs/fs-local/README.md) and [`fs-sandbox`](../../fs/fs-sandbox/README.md), preserving symlink identity, stale-version rejection, diff bases and publication semantics. UTF-8 streaming uses bounded pull requests and closes its remote iterator when the consumer stops early.Further Exploration
- Filesystem subsystem — shared operations and error meanings.
- SSH connection — deployment and disconnection behavior.
Model Experience
Indirectly, through existing filesystem consumers, which present remote paths and file contents while owning every tool and prompt.
KV Cache effect
This provider contributes no request-prefix content. Its consumers own model-visible tools and results.
Known Limitations and Deferred Work
- Whole-text reads and individual byte windows are limited to 8 MiB by the helper. Use text streaming or multiple byte windows for larger reads; other JSON transfers also obey the connection’s frame cap.
- Remote file URLs are execution coordinates, not host filesystem handles or Web download links.