# @agentrq/agentrq-ws 中文文档

规范地址：https://npmcn.com/package/%40agentrq/agentrq-ws/

版本：0\.15\.7
npm 元数据更新时间：2026-11-05T07:19:11.616Z
中文译文更新时间：2026-11-06T07:22:44.918Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40agentrq/agentrq-ws
原文对照：https://npmcn.com/package/%40agentrq/agentrq-ws/?lang=original
项目主页：https://github.com/agentrq/agentrq/tree/main/cli/agentrq-ws
源码仓库：https://github.com/agentrq/agentrq

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：78.7 kB，13 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20\.6\.0
- 运行依赖：0 个
- 首次发布：2026-09-17T08:31:34.573Z
- 最新版本发布：2026-11-05T07:19:11.284Z
- 近 30 天下载量：4198（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：57（近 12 个月 57 个）

## 中文简介

AgentRQ工作空间客户端 — 从命令行驱动 AgentRQ工作空间, 使用工作空间自己的. mcp.json

## 安装

```sh
npm install @agentrq/agentrq-ws
```

也可以使用：`pnpm add @agentrq/agentrq-ws`、`yarn add @agentrq/agentrq-ws`、`bun add @agentrq/agentrq-ws`

## README

# @ agentrq/ agentrq-ws (英语)

AgentRQ工作空间客户端:从一个 贝壳,不花 代理的标志来做.

```bash
npx -y @agentrq/agentrq-ws@latest help
```

它读到 `.mcp.json` 在当前目录中 —— 代理文件相同 在那里工作,所以在工作空间的检查中 没有什么 配置 .

```bash
cd ~/code/my-workspace
npx -y @agentrq/agentrq-ws@latest workspace
```

## 为什么它存在

代理商在工作空间谈论MCP,这是代理商的正确形状 和错误的形状一个人:每一次呼叫都是JSON信封,每一次 回答是代理支付代币. 同样的7个工具都在这下面 CLI,但命令是一行外壳,答案是纯文本.

阅读附件和 _处理_ 一个——见 见下文.

## 安装

没有要安装的 : `npx -y @agentrq/agentrq-ws@latest <command>` 捡起来 它没有运行时间依赖。 为了保持它周围:

```bash
npm install -g @agentrq/agentrq-ws
agentrq-ws help
```

节点20.6或更新.

## 图标

| 命令 | 它会做什么 |
| --- | --- |
| `workspace` | 显示工作空间标题和任务 |
| `task get <taskId>` | 获取任务, 用 `--conversation` 历史 |
| `task next` | 承担下一个尚未开始的任务—— **此将队列按住** |
| `task create <title>` | 创建一个任务,使用 `--clear-context` 发送 `/clear` 先给探员 |
| `task status <taskId> <status>` | 设定任务状态 |
| `task help [action]` | 服务器的帮助 `task` 工具:每个动作,或一个动作的有效载荷 |
| `reply <taskId> <text>` | 向任务发送信息 |
| `attachment get <id> --task <taskId>` | 下载文件的附件 |
| `memory load [name]` | 读取工作空间内存( 默认为索引) |
| `memory save [name] --content …` | 替换工作空间内存 |
| `memory delete [name]` | 删除工作空间内存 |
| `skill search [q]` | 找出这个工作空间能够使用的技能,按名称或描述; `--limit`编号 :`--offset` 页 次 |
| `skill load <uri>` | 读取技能文件( E)`skill://<name>` 读它 `SKILL.md`(中文(简体) ) |
| `skill save <uri> --content …` | 替换此工作空间之一的技能的文件 |
| `skill delete <uri>` | 从这个工作空间取出一个技能( O)`skill://<name>`),在没有其他工作空间使用时删除,或者删除其一个文件 |
| `pano save [id --version N] --title … --markdown …` | 创建 Pano doc, 或者替换一个, 并打印其标识和版本; 替换需要 `--version` 如果医生从此改变,你将会阅读,并且被拒绝; `--file` 发送一个文件 标记下链接, `--ttl-days` 财务报告和审定财务报表 `--color` 设定生命和后它 |
| `pano edit <id> --version N …` | 更改一个 Doc 的一部分而不重发 : `--replace TEXT --with TEXT` (案文必须发生一次), `--append TEXT`,或 `--ops` 作为 JSON 阵列; 操作全部或全部应用。 打印 ID 和新版本 |
| `pano read <id>` | 读取 Pano 文件( 其) `version` 列入, `--comments`编号 :`--attachments` 添加这些内容; `--out DIR` 写下并下载其文件,打印其版本及其路径 |
| `pano comment <id> <text>` | 关于 Pano doc 的评论 |
| `pano attach <id> --file PATH…` | 将文件附加到 Pano doc; 它们不需要链接 |
| `pano delete <id>` | 删除 Pano doc |
| `pano help [action]` | 服务器的帮助 `pano` 工具:每个动作,或一个动作的有效载荷 |
| `event publish <name>` | 发布一个命名的事件 |
| `ask <taskId> <message>` | 问人类一个问题,等着 |
| `site-tools [q]` | 列出Chrome扩展中与这个工作空间共享的网站及其工具的名称和描述; `q` 把工具排好, `--pattern` 通过正则表达式过滤它们, `--limit`编号 :`--offset` 页 次 |
| `site-tool <site> <tool>` | 显示一个共享网站的全部工具, 及其输入方案 |
| `call-site-tool <site> <tool> --task <taskId>` | 运行一个共享网站的工具 在人类的克罗姆,与 `--args '{…}'` |
| `tools` | 列出工作空间服务器提供的工具 |
| `tools help [tool|tool.action]` | 服务器的帮助:每个工具,一个工具的动作,或者一个动作的有效载荷都有实例 |
| `call <tool> --args '{…}'` | 直接调用任何工具 |

每个命令都用 `--help`每个家庭也一样:

```bash
agentrq-ws task --help          # lists task get / next / create / status / help
agentrq-ws attachment get -h    # the one command, its options and defaults
```

`task next` 是一个单独的动词 而不是赤裸的 `task get` 目标: 要求工作, 并且命令 变异队列应该以它的名义说.

## 随身物品从不成为你的问题

基础工具双向说基础64. 这个CLI没有.

**上传** 走一条路。 文件名、媒体类型和编码已经制定 为你:

```bash
agentrq-ws reply 0isnjTCkpW5 "Build is green — log attached" --attach ./run.log
agentrq-ws task create "Review the design" --body @brief.md --attach ./mock.png
```

**下载** 写一个文件并打印它去了哪里。 没有 `--out` 它着陆了 在OS临时目录中:

```bash
$ agentrq-ws attachment get 0isp9dJxr85 --task 0isnjTCkpW5
/tmp/agentrq-ws-help.txt
```

`--out` 选择目录( 保留附件的自有名称) 或完整路径 (更名为:

```bash
agentrq-ws attachment get 0isp9dJxr85 --task 0isnjTCkpW5 --out ~/Downloads
agentrq-ws attachment get 0isp9dJxr85 --task 0isnjTCkpW5 --out ./report.pdf
```

这个 `--task` 是因为附件属于任务。 CLI问 用于附件的公开链接,下载,并保存文件 一个人类给它起的名字, 一个没有链接的更古老的附着者 以同样的方式到达, 从内容.

## 长文本

任何传道的场所 `--body`, (中文(简体) ), `--content`, (中文(简体) ), `--payload`,并回复 文本 - `@path` 读取文件并 `-` 读取 stdin :

```bash
agentrq-ws task create "Post-mortem" --body @notes.md
git log --oneline -20 | agentrq-ws reply 0isnjTCkpW5 -
agentrq-ws memory save release-notes.md --content @CHANGELOG.md
```

## 问人类什么

```bash
# a form
agentrq-ws ask 0isnjTCkpW5 "Which branch should I release from?" \
  --field branch:string:"Branch name" --field sign:boolean:"Sign the tag?"

# or a link to go and do something
agentrq-ws ask 0isnjTCkpW5 "Approve the deploy, then confirm" --url https://example.com/approve
```

两种阻隔直到人类的答案或超时(`--timeout`一个小时 以违约或最多违约计算.

## 产出

命令打印服务器的文本 . `--json` 打印原始结果取而代之,用于 管道进入 `jq`数字 :

```bash
agentrq-ws tools --json | jq -r '.[].name'
```

无法打印一行并退出非零。 堆栈追踪是指CLI中的一个错误, 不是命令错误.

## 选择服务器

离这里最近的 `.mcp.json` 在工作目录上或以上使用。 当它 定义多个服务器, 名称为 :

```bash
agentrq-ws workspace --server agentrq-workspace
agentrq-ws workspace --config ../other/.mcp.json
```

| 变量 | 效果 |
| --- | --- |
| `AGENTRQ_WS_URL` | 使用此服务器 URL并忽略 `.mcp.json` 完全没有 |
| `AGENTRQ_WS_SERVER` | 在哪个服务器中 `.mcp.json` 用于 |

## 发展

```bash
cd cli/agentrq-ws
npm test                  # 147 tests, no network
npm run test:coverage
```

测试驱动整个路径 — argv, 配置加载, MCP 握手, SSE 框架, 文件在磁盘上—— 只有套接字被替换 .

## 许可证

阿帕奇 - 2.0

## 常见问题

### @agentrq/agentrq-ws 是什么？

AgentRQ工作空间客户端 — 从命令行驱动 AgentRQ工作空间, 使用工作空间自己的\. mcp\.json

### 如何安装 @agentrq/agentrq-ws？

在项目目录运行 npm install @agentrq/agentrq-ws，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 agentrq-ws，可以用 npx agentrq-ws 直接运行。

### @agentrq/agentrq-ws 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/agentrq\_\_agentrq-ws 是否存在。

### @agentrq/agentrq-ws 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @agentrq/agentrq-ws 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.6\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @agentrq/agentrq-ws 可以商用吗？

@agentrq/agentrq-ws 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @agentrq/agentrq-ws 的下载量有多少？

根据 npm 官方下载统计，@agentrq/agentrq-ws 在 2026/10/05 – 2026/11/03 这 30 天内被下载 4,198 次，日均约 140 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @agentrq/agentrq-ws 还在维护吗？

最新版本 0\.15\.7 发布于 2026/11/05（1 天前）；至今共发布 57 个版本，其中过去 12 个月发布了 57 个；首次发布于 2026/09/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。