# agent-workplace 中文文档

规范地址：https://npmcn.com/package/agent-workplace/

版本：0\.10\.1
npm 元数据更新时间：2026-11-03T01:53:40.071Z
中文译文更新时间：2026-11-03T02:06:37.355Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/agent-workplace
原文对照：https://npmcn.com/package/agent-workplace/?lang=original
项目主页：https://docs.agentworkplace.dev/
源码仓库：https://github.com/agentworkplace/cli

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

- 包体积（解压后）：365 kB，75 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.12 \<23 \|\| \>=24 \<25
- 运行依赖：3 个
- 首次发布：2026-09-23T06:59:29.456Z
- 最新版本发布：2026-11-03T01:53:39.733Z
- 已发布版本数：18（近 12 个月 18 个）

## 中文简介

Agent Workplace的命令行客户端

## 安装

```sh
npm install agent-workplace
```

也可以使用：`pnpm add agent-workplace`、`yarn add agent-workplace`、`bun add agent-workplace`

## README

![Agent Workplace CLI](https://raw.githubusercontent.com/agentworkplace/cli/main/.github/assets/readme-banner.png)

[![npm version](https://shieldcn.dev/npm/agent-workplace.svg?label=npm&logo=npm&color=000000&font=geist)](https://www.npmjs.com/package/agent-workplace) [![npm provenance](https://shieldcn.dev/badge/provenance-SLSA-000000.svg?logo=lu:ShieldCheck&font=geist)](https://www.npmjs.com/package/agent-workplace) [![Node.js 22.12 or later and 24](https://shieldcn.dev/badge/Node.js-22.12%2B%20%7C%2024-000000.svg?logo=nodedotjs&font=geist)](https://github.com/agentworkplace/cli/blob/main/package.json) [![MIT license](https://shieldcn.dev/badge/license-MIT-000000.svg?logo=lu:Scale&font=geist)](https://github.com/agentworkplace/cli/blob/main/LICENSE) [![Documentation](https://shieldcn.dev/badge/docs-000000.svg?logo=lu:BookOpen&font=geist)](https://docs.agentworkplace.dev/) [![CI status on main](https://shieldcn.dev/github/ci/agentworkplace/cli.svg?workflow=ci.yml&branch=main&color=000000&font=geist)](https://github.com/agentworkplace/cli/actions/workflows/ci.yml)

## Agent Workplace命令行

用于人员和外部操作的代理的对Agent Workplace的命令行访问。

> \[!警告) **早期的测试版**  
> Agent Workplace正在积极发展。api、sdk、CLI命令和产品行为可能会发生变化，包括破坏性变化。检查 [产品的更新日志](https://agentworkplace.dev/changelog) 在升级之前，pin SDK和CLI版本以实现可重复的工作流程。客户端固定不固定托管API或保证持续的兼容性。

```sh
npm install --global agent-workplace@0.10.1
agent-workplace --help
agent-workplace docs search "signup"
agent-workplace docs /documentation/guides/send-mail
```

支持的运行时：22. js中的Node.js 22.12或更高版本。和Node.js 24.x系列。命令行使用Agent 工作场所SDK和HTTP API。不需要基础设施或提供者凭证。 新注册用途 `https://api.agentworkplace.dev` 默认情况下。 对于登台或本地开发，请设置 `AGENT_WORKPLACE_API_URL` 到那个API 来源。保存的凭据和邀请仍然与原始来源绑定； 在请求之前拒绝另一个源的环境设置。 `docs` 列出当前发布的文档，搜索带有摘要的页面，并打印 指南或生成的API引用按规范路径Markdown。它之前是有效的 注册，从不读取帐户凭据。添加 `--json` 对于结构化输出； 安装 `--help` 拥有特定于版本的命令选项。

如果您已经拥有一个帐户及其保存的凭据，请运行 `agent-workplace account-status --json` 检查当前访问权限。否则,遵循 这个 [快速启动](https://docs.agentworkplace.dev/documentation/get-started/quick-start) 创建工作场所或使用现有工作场所的邀请路径。这个 [账户指南](https://docs.agentworkplace.dev/documentation/guides/create-workplace) 包括所有权确认和恢复。存储凭证和收据文件 具有仅属于所有者的权限；请勿粘贴到日志或公开消息中。 可以设置没有私有文件系统的运行时 `AGENT_WORKPLACE_API_KEY` 到一个 专用帐户密钥，而不是使用默认凭证文件；命令 保存凭证状态拒绝它。看到 [CLI参考](https://docs.agentworkplace.dev/documentation/integrations/cli#key-from-the-environment). 成功的JSON结果输出到stdout；诊断转到错误和故障使用 非零退出代码。

看到 [文档](https://docs.agentworkplace.dev/) 邮件，文件，账单， 权限和恢复。API的可用性和访问由宿主控制 独立于软件包安装的服务。

麻省理工学院的许可。支持: [support@agentworkplace.dev](mailto:support@agentworkplace.dev). 来源和贡献： [agentworkplace / cli](https://github.com/agentworkplace/cli).

## 故障诊断命令

检查 `agent-workplace --version` 以及受影响的命令 `--help` 当 已发布的文档描述了您的安装无法识别的选项。 对于脚本，检查退出代码并从标准输出中单独捕获标准错误； `--json` 不会将失败的命令转换为成功的结果。

如果突变被中断，请按照该命令记录的恢复过程进行操作 并保留其私人收据或原始操作/提交ID。一个超时 单独不能确定服务器拒绝了该操作。从来没有包括 支持报告中的凭证文件或私人收据。

## 开发

对于源代码签出，请运行 `npm ci` 和 `npm run verify`． 贡献的指导 在源存储库中。

## 常见问题

### agent-workplace 是什么？

Agent Workplace的命令行客户端

### 如何安装 agent-workplace？

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

### agent-workplace 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### agent-workplace 支持 ESM 还是 CommonJS？

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

### agent-workplace 需要什么版本的 Node\.js？

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

### agent-workplace 可以商用吗？

agent-workplace 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### agent-workplace 还在维护吗？

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