4.8 KiB
description, kind
| description | kind |
|---|---|
| 宿主原生命令与路径打开工具，提供无 shell 执行、取消、桌面探测与 WSL 路径交接。 | package-library |
@deepseek-ai/dsh-native-command
English | 中文
概述
dsh-native-command 无需 shell 即可运行 Host 可执行文件，并通过桌面打开 Host 文件系统路径。命令运行器捕获 utf8 输出、传播取消，并隐藏 Windows 瞬时控制台。路径打开器支持默认应用与文本编辑器意图、浏览器可渲染文档、WSL 转换与桌面可用性检查。它是库而非插件：没有 ctx、无状态、不发事件。
目录
使用本包
当宿主侧集成需要执行一条原生命令、并需要它的输出或失败信息（或两者兼要）、且绝不能涉及 shell 时，使用本运行器。
运行一条命令
import { runNativeCommand } from '@deepseek-ai/dsh-native-command'
declare const script: string
declare const signal: AbortSignal
const { stdout, stderr } = await runNativeCommand('osascript', ['-e', script], signal)
退出码为 0 时，调用解析为捕获到的 stdout 与 stderr。任何失败都会以错误拒绝，错误附带退出 code 与两路已捕获输出，因此调用方无需重跑命令即可区分工具缺失（ENOENT）、取消（ABORT_ERR）与真实的命令失败。
注入命令边界
NativeCommandRunner 类型是宿主集成的可注入命令边界：在集成需要一个可测试接缝的位置传入该函数（或其包装层），测试即可替换为假运行器。
打开 Host 路径
openNativePath(path, signal) 将路径交给默认应用；平台能够确定默认浏览器时，HTML 与 SVG 会优先交给该浏览器。openNativeTextFile(path, signal) 选择文本编辑器意图；macOS 使用 open -t。WSL 路径先通过 wslpath -w 转换，再交给 Windows 桌面。canOpenNativePath() 报告当前 Host 是否可能具备桌面目标。
理解实现
实现细节——点击展开
命令运行器是 Node execFile 的薄包装。路径打开器根据平台与环境事实选择一条无 shell 命令，而调用方继续负责决定允许打开哪个路径。
源码地图
| 文件 | 职责 |
|---|---|
src/index.ts |
命令运行器与路径打开器的公共导出 |
src/runner.ts |
无 shell 的 execFile 适配器 |
src/path-opener.ts |
桌面探测、打开意图、浏览器偏好与 WSL 转换 |
src/invariant.ts |
不变式伴生插件（无运行时不变式；每次运行都是一次无状态的子进程往返） |
execFile 给了运行器什么
execFile 以 argv 数组直接 spawn 可执行文件——没有 shell 字符串，参数不经 shell 解释。signal 选项在调用方中止触发时终止子进程；windowsHide 在 Windows 上抑制瞬时控制台窗口。遇到非零退出或 spawn 错误时，回调把 code、stdout、stderr 挂到被拒绝的错误上，并保留原始错误作为 cause。
进一步探索
当你需要消费方或本工具刻意不属于的通用子进程能力时，阅读以下页面。
- 原生目录选择器——本运行器执行的 OS 选择器命令。
- Session Controller——打开前解析 Session 相对 workspace 路径。
- Settings Controller——选择 settings 文档与 agent-preset 目录。
- 子进程能力——通用子进程 seam，本包并非其组成部分。
模型体验
无：宿主侧工具不注册任何面向模型的内容。
KV Cache 影响
此处没有任何内容进入请求前缀；本包既不组装也不发送提供方请求。
已知限制与延期工作
这些限制说明本运行器何时不是合适的工具。它们是当前包约束，不是任务积压。
- 不做输出限量——两路流在内存中无界缓冲；当前每个调用方只运行输出为一个路径或一行错误的小型原生工具。把它指向输出量可观的命令之前，先接入
dsh-output-retention限量。
开发备注
维护者的工作上下文——点击展开
无。