# @ai-setting/roy-agent-cli 中文文档

规范地址：https://npmcn.com/package/%40ai-setting/roy-agent-cli/

版本：1\.7\.77
npm 元数据更新时间：2026-11-06T07:25:06.355Z
中文译文更新时间：2026-11-06T04:25:18.609Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40ai-setting/roy-agent-cli
原文对照：https://npmcn.com/package/%40ai-setting/roy-agent-cli/?lang=original
项目主页：https://github.com/ai-setting/roy-agent#readme
源码仓库：https://github.com/ai-setting/roy-agent

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

- 包体积（解压后）：130 MB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：25 个
- 首次发布：2026-05-07T08:39:08.072Z
- 最新版本发布：2026-11-06T07:25:05.639Z
- 近 30 天下载量：5168（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：233（近 12 个月 233 个）

## 中文简介

Roy-agent-非交互命令执行的CLI

## 安装

```sh
npm install @ai-setting/roy-agent-cli
```

也可以使用：`pnpm add @ai-setting/roy-agent-cli`、`yarn add @ai-setting/roy-agent-cli`、`bun add @ai-setting/roy-agent-cli`

## README

# @ai-setting/roy-agent-cli (英语)

Roy -agent的命令行界面. 提供非交互命令执行.

## 工具链协作

| 页:1 | 职责 | 使用场景 |
| --- | --- | --- |
| **小时** | 包管理、依赖安装、发布 | `pnpm install`, (中文(简体) ), `pnpm publish` |
| **缓冲** | SDK 捆绑 QQ | `bun run build` |
| **构建- cli- dev.ts** | 德夫 构建 (QQ sourcemap) | `bun run build:cli:dev:single` |
| **构建- cli- prod.ts** | Prod ^ (独立) | `bun run build:cli:prod:single` |

## 构建

### 构建模式

| 页:1 | 命令 | 产物 | 页:1 |
| --- | --- | --- | --- |
| **SDK 套装** | `bun run build` | `dist/index.js`, (中文(简体) ), `dist/bin/roy-agent.js` | {\\fn黑体\\fs22\\bord1\\shad0\\3ahbe\\4ah00\\fscx67\\fscy66\\2chffffff\\3ch808080}不 不 不 {\\fn黑体\\fs22\\bord1\\shad0\\3ahbe\\4ah00\\fscx67\\fscy66\\2chffffff\\3ch808080}不 不 |
| **德维** | `bun run build:cli:dev:single` | `dist/bin/roy-agent.js` + 源图 | 本地平台,调试用 |
| **单人** | `bun run build:cli:prod:single` | `dist/roy-agent-*/bin/roy-agent` | 本地平台,独立地 |
| **全体选手** | `bun run build:cli:prod` | `dist/roy-agent-*/bin/roy-agent` | 5分25分,独立 |

### D. 编剧:

生成带有 **源图** chh 捆绑,qq `.ts` 文件路径和行号。

```bash
bun run build:cli:dev:single

# 运行
bun packages/cli/dist/bin/roy-agent.js act "hello"
```

### Prod 338号

生成 **独立**键。

```bash
# 本地平台
bun run build:cli:prod:single

# 全平台（linux-x64, linux-arm64, darwin-x64, darwin-arm64, windows-x64）
bun run build:cli:prod
```

## 发展

源码运行:

```bash
bun packages/cli/src/bin/roy-agent.ts
```

## 使用量

### CLI 二进制

```bash
# Interactive mode
roy-agent

# Execute task
roy-agent act "帮我写一个 hello world"

# With options
roy-agent act "任务" --model gpt-4 --quiet
```

### SDK 导入

```typescript
import { runCli } from "@ai-setting/roy-agent-cli";

// Run CLI
await runCli();
```

## 出版

```bash
# 1. SDK bundle 编译（bunup）
bun run build

# 2. 发布到 npm
cd packages/cli
pnpm publish --access public
```

## 依赖关系

-   `@ai-setting/roy-agent-core` - 核心SDK软件
-   `@ai-setting/roy-agent-coder-harness` - 液相接绳
-   `chalk` - 终端颜色
-   `yargs` - CLI 参数解析

## 常见问题

### @ai-setting/roy-agent-cli 是什么？

Roy-agent-非交互命令执行的CLI

### 如何安装 @ai-setting/roy-agent-cli？

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

### @ai-setting/roy-agent-cli 支持 TypeScript 吗？

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

### @ai-setting/roy-agent-cli 支持 ESM 还是 CommonJS？

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

### @ai-setting/roy-agent-cli 需要什么版本的 Node\.js？

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

### @ai-setting/roy-agent-cli 可以商用吗？

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

### @ai-setting/roy-agent-cli 的下载量有多少？

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

### @ai-setting/roy-agent-cli 还在维护吗？

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