dsh-at-file
FSMargoo/dsh-at-fileCodex 风格的 `@file` 文件引用,输入框里直接搜索并引用工作区文件。
文件浏览器 Web 应用:React 前端与 REST API 由宿主 webserver 托管,/dsh-agfs 命令自动定位当前工作区,附 browse_files 模型工具。
English | 中文
面向 DeepSeek Harness 的文件浏览器插件——由宿主 webserver 托管的 React 前端与 REST API,附带 /dsh-agfs 命令与 browse_files/read_file 模型工具。随 dsh web 同进程运行:无独立端口、无子进程。
| 面包屑导航 | 视图切换 | 侧边栏 |
|---|---|---|
| 搜索 | 本地打开 |
|---|---|
/dsh-agfs 命令——在系统默认浏览器中打开文件浏览器,并自动定位到当前会话的工作区目录(session cwd);切换工作区后再次执行会自动跟随。browse_files / read_file 模型工具——模型可直接列出/递归搜索浏览根,并读取其中的文本文件。strictRoot 实路径校验、符号链接/连接点逃逸拦截(干净 400 信封)、readOnly 只读模式、remoteMode 远程禁用。X-Content-Type-Options: nosniff、X-Frame-Options: DENY、Referrer-Policy: no-referrer。dsh.bundle 一键安装——作为 profile 层一条命令激活。在 DeepSeek Harness web 界面的对话框里,直接用自然语言让智能体安装,例如:
帮我安装文件浏览器插件
dsh-agfs
安装
@open-agfs/dsh-agfs这个 npm 包
智能体会调用 shell 工具执行:
dsh plugin --profile web add @open-agfs/dsh-agfs
然后重启 dsh web(或让智能体帮你重启),在对话框输入 /dsh-agfs 即可打开文件浏览器。
前置条件:该方式要求当前 profile 的智能体启用了 shell 工具(
bash/pwsh)并授予执行权限。web profile 默认禁用 shell 工具——可在「设置 → 工具/权限」中启用,或当智能体请求执行命令时选择允许。未启用时请用方式二。
dsh plugin --profile web add @open-agfs/dsh-agfs
安装完成后重启 dsh web,在对话框输入 /dsh-agfs 打开文件浏览器。
升级到新版本:
dsh plugin --profile web add @open-agfs/dsh-agfs@latest
从仓库检出用 --patch 覆盖层挂载源码:
- insert:
- id: dsh-agfs
name: 'file:///绝对路径/dsh-agfs/src/index.ts'
然后 dsh web --patch ./overlay.yml。插件代码改动需重启 dsh;前端资源按请求从磁盘读取。
/dsh-agfs:系统默认浏览器打开文件浏览器并返回地址;若当前会话带有工作区目录(session cwd),浏览器会直接定位到该工作区。openOnCommand: false 时只返回地址,不打开浏览器。readOnly 限制)。| Key | 默认 | 含义 |
|---|---|---|
basePath | /dsh-agfs | 服务应用与 API 的路由前缀;必须以 / 开头且不以 / 结尾 |
fileRoot | 当前工作目录 | 浏览根;侧边栏仍可访问各磁盘 |
projectRoot | 当前工作目录 | 侧边栏「项目目录」 |
remoteMode | false | 为 true 时禁用 open、open_location、copy 端点 |
readOnly | false | 为 true 时 delete、create_folder、rename、copy 返回 403;浏览保持可读 |
strictRoot | false | 为 true 时浏览锁定在 fileRoot 内:拒绝绝对路径,符号链接/连接点逃逸返回 400 |
roots | {} | 侧边栏自定义根,name -> path;解析不到的条目自动丢弃,其余按名排序 |
openOnCommand | true | /dsh-agfs 是否自动打开系统默认浏览器 |
debug | false | 为 true 时把 API 调用与系统打开结果以 [dsh-agfs:debug] 前缀写入 dsh 进程 stderr |
配置写在 profile 的用户补丁层($DSH_HOME/profiles/<name>/cordis.patch.yml),例如:
- id: dsh-agfs
config:
fileRoot: 'D:/projects/my-project'
readOnly: true
前端调用 ${basePath}/api/file_browser/ 下的端点:list、read、download、open、open_location、search、info、workspace、sidebar、thumbnail、mode、debug、delete、create_folder、rename、copy,以及 analyze(一键AI分析,仅本机模式)。路径被限定在浏览根内;search 支持 recursive=1(也接受 true/yes)递归遍历,命中上限 200、目录深度上限 5。所有响应带安全响应头;静态资源只响应 GET/HEAD。
插件注册两个模型工具,复用与 HTTP 层相同的纯函数核心:
browse_files(参数 path、keyword、recursive)——列出目录或搜索条目名(可选递归)。返回规范值 { items: [...] },渲染为 TYPE<TAB>SIZE<TAB>PATH 文本行;空 keyword 自动回退为普通列出。read_file(参数 path)——读取浏览根下的一个 UTF-8 文本文件(markdown、代码、日志)并返回内容,让分析智能体可以查看文件内容而不只是文件名。参数 schema 与描述随工具注册自动流入模型提示词。
app.js 取代),但工具栏图标仍来自 cdnjs;无网络时应用可用但无图标。search 匹配单目录条目名(上限 200),未实现递归内容搜索。openOnCommand 在宿主机上产生副作用——浏览器在运行 dsh 的机器上打开,loopback 部署正确,对远程客户端有违直觉。pnpm install
pnpm test # vitest:单元套件 + 真实 Loader 组合套件(94 测试)
pnpm typecheck # tsc --noEmit
pnpm lint # oxlint
pnpm build # tsc 类型 + tsdown 打包 -> lib/
pnpm run build:frontend # 修改 assets/app.jsx 后重新生成 assets/app.js
前端源码 assets/app.jsx,编译产物 assets/app.js(classic JSX runtime,无 Babel)与 assets/vendor/ 下的 React/ReactDOM UMD 构建随包发布。
发布由 tag 驱动:推 v* tag 会触发 GitHub Actions(.github/workflows/publish.yml)自动发布到 npm。tag 完全手动触发——脚本不会自动打 tag:
pnpm run release # 仅查看发布状态(不写入)
pnpm run release -- --do # 立即发版(递增 patch):提交 + 打 tag + 推送
pnpm run release -- --do --version 0.2.0 # 按指定版本发版
pnpm run release -- --do --dry-run # 预览(不写入、不推送)
scripts/release.mjs 无参数时打印当前版本、上次 v* tag 及自其以来的提交数;带 --do 时递增版本、提交 chore: release vX.Y.Z、创建 tag 并推送 main 与 tag。仓库需配置 AGFS secret(带 bypass-2FA 的细粒度 npm 发布 token)。本包把已发布的 @deepseek-ai/dsh-* 工具链包声明为 peer 依赖,发布安装可从 npm 解析。
^22.19 || >=24;peer 依赖 @deepseek-ai/dsh-*(rc.6)