@ai-setting/roy-agent-cli

中文文档
1.7.77发布于 2026/11/06MITTypeScriptES Module近 30 天下载 5168

CLI for roy-agent - Non-interactive command execution

原始使用文档
文档目录11 节
  1. 工具链协作
  2. Build
  3. 构建模式
  4. Dev 模式
  5. Prod 模式
  6. Development
  7. Usage
  8. CLI Binary
  9. SDK Import
  10. Publishing
  11. Dependencies

@ai-setting/roy-agent-cli

Command-line interface for roy-agent. Provides non-interactive command execution.

工具链协作

工具职责使用场景
pnpm包管理、依赖安装、发布pnpm install, pnpm publish
bunupSDK bundle 编译bun run build
build-cli-dev.tsDev 构建(源码 sourcemap)bun run build:cli:dev:single
build-cli-prod.tsProd 构建(standalone)bun run build:cli:prod:single

Build

构建模式

模式命令产物说明
SDK Bundlebun run builddist/index.js, dist/bin/roy-agent.jsbunup 编译,用于 npm 发布
Devbun run build:cli:dev:singledist/bin/roy-agent.js + sourcemap本地平台,调试用
Prod Singlebun run build:cli:prod:singledist/roy-agent-*/bin/roy-agent本地平台,standalone
Prod Allbun run build:cli:proddist/roy-agent-*/bin/roy-agent全平台 5 个,standalone

Dev 模式

生成带有 sourcemap 的 bundle,日志可显示准确的 .ts 文件路径和行号。

bun run build:cli:dev:single

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

Prod 模式

生成 standalone 可执行文件。

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

# 全平台(linux-x64, linux-arm64, darwin-x64, darwin-arm64, windows-x64)
bun run build:cli:prod

Development

源码运行:

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

Usage

CLI Binary

# Interactive mode
roy-agent

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

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

SDK Import

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

// Run CLI
await runCli();

Publishing

# 1. SDK bundle 编译(bunup)
bun run build

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

Dependencies

  • @ai-setting/roy-agent-core - Core SDK
  • @ai-setting/roy-agent-coder-harness - LSP harness
  • chalk - Terminal colors
  • yargs - CLI argument parsing

版本与发布记录

@ai-setting/roy-agent-cli 共发布 233 个版本,首次发布于 2026/05/07;过去 12 个月发布了 233 个版本。

版本发布日期距今
1.7.77latest2026/11/061 天前
1.7.762026/11/061 天前
1.7.752026/11/052 天前
1.7.722026/11/043 天前
1.7.712026/11/043 天前
1.7.702026/11/034 天前

其他发布通道:beta → 1.6.10-beta.2。

关于 @ai-setting/roy-agent-cli 的常见问题

@ai-setting/roy-agent-cli 是什么?

CLI for roy-agent - Non-interactive command execution

如何安装 @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 和提交记录判断。