贝里尔CLI
命令行上的贝里尔:创建工程,作者测试,
触发器在 CI 中运行, 并管理所有网络应用程序可以做到的 。 编码代理到达相同
通过贝里尔主机的 MCP 服务器发布命令 https://api.beryl.so/mcp。 。 。 .
快速启动: 一个命令
npx @beryl-so/cli@latest init
将您签入( 默认情况下浏览器批准, 通过电子邮件发送一次性代码作为倒置; 新建) 电子邮件在当场注册,在 用 -- claude、 -- cursor、 -- vscode 或 -- opencode 选择代理人( 它询问您何时通过) ),并安装了贝里尔测试写作技能. 安全地重新运行.
安装
npm install -g @beryl-so/cli # `beryl` on your PATH
npx @beryl-so/cli@latest … # or run one-off without installing
从单发( 开发) : cd cli && npm install && npm run build && npm link。 。 。 .
beryl version 报告运行中的 CLI 是否落后于最近的 npm 发布
(最佳成绩). 设定 BERYL_NO_UPDATE_CHECK=1 跳过支票.
CLI 报告命令运行( 绝不是参数或输出) 因此登入可以
被测量; 设置 BERYL_TELEMETRY=0 或者说 DO_NOT_TRACK=1 什么也没有.
认证
beryl login # opens the browser to approve; press Enter for an emailed code instead
beryl login --otp # skip the browser; emailed one-time code (signs up new emails too)
export BERYL_API_KEY=beryl_pat_… # CI: use a token from Account → Personal access tokens
配置只存储您的令牌 + API URL; 其他的都不再存在 。 指向一个命令
工作空间/项目 --workspace 编号 : --project 旗帜或 BERYL_WORKSPACE 编号 :
BERYL_PROJECT env vars; 准确的说,CLI自动选择它.
优先发言:旗帜 > BERYL_* env > 自动选取 if-1.
单行 CI
beryl runs trigger --url-override "$PREVIEW_URL" --watch --timeout 30
退出代码 : 0 成功/所有测试通过 1 失败 2 使用错误 ^ 3 认证错误 ^ 4 计划限额已经达到.
工程 CI 符号( A)BERYL_TOKEN=beryl_ci_…,来自项目的设置, CI 标签)是
足以触发运行和将简短变成测试: beryl jobs create "Cover the brief" --file ./brief.md --ci
(通过) --workspace 财务报告和审定财务报表 --project 编号). CI 任务从不等待输入; 登录内容
块列为跳过 beryl jobs get。 。 。 .
MCP 服务器
claude mcp add --transport http -s user beryl https://api.beryl.so/mcp
您的代理在第一次连接时通过服务器的 OAuth 在服务器的 OAuth 中签名( 在 Claude)
代码,运行 /mcp 并选取贝里尔。 没有 OAuth 的客户端发送个人访问令牌为
Authorization: Bearer beryl_pat_…。服务器总是流畅的,所以没有什么
用于更新.
下方大多数非交互命令作为同名的 MCP 工具被曝光
(空格和破折线成为下划线);参见MCP工具栏. none 标记命令
仅保留 CLI : 账户/帐单/团队管理、反馈、云层探索和命令
读取或写出本地磁盘(logout, (中文(简体) ), config files upload, (中文(简体) ), config signing set) (中文(简体) ).
图标
输入
在此 Repo 中设置 Beryl: 签名并连接您的编码代理
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl init | 在此 Repo 中设置 Beryl: 签名并连接您的编码代理 | 无 |
指南
打印贝里尔测试指南, 或其中一部分
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl guide [topic] | 打印贝里尔测试指南, 或其中一部分 | guide |
登录
用您的 Beryl 账户认证 CLI
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl login | 用您的 Beryl 账户认证 CLI | 无 |
注册
注册一个新的Beryl账户(电子邮件一个6位数的验证码)
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl signup | 注册一个新的Beryl账户(电子邮件一个6位数的验证码) | signup |
登录
从 CLI 配置中删除已存储的令牌
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl logout | 从 CLI 配置中删除已存储的令牌 | 无 |
华美
显示登录账户
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl whoami | 显示登录账户 | whoami |
符号
管理认证 CLI 和 CI 的个人访问符 .
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl tokens list | 列出您的个人访问标志 | tokens_list |
beryl tokens create <name> | 薄荷新个人访问符 (刷一次) | tokens_create |
beryl tokens revoke <token-id> | 撤销个人访问令牌 | tokens_revoke |
beryl tokens dismiss <token-id> | 从您的列表中删除一个已重新打开的符号 | tokens_dismiss |
工作空间
创建并管理工作空间, 并选择您命令默认操作的空间 .
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl workspaces list | 列出您所属的工作空间 | workspaces_list |
beryl workspaces get | 显示一个工作空间 | workspaces_get |
beryl workspaces create <name> | 创建工作空间 | workspaces_create |
beryl workspaces update | 重命名工作空间或更改其能见度 | workspaces_update |
beryl workspaces delete | 删除工作空间和其中的所有内容 | workspaces_delete |
beryl workspaces history | 显示工作空间及其项目( 时间表、 测试、 组合、 环境、 配置名称、 账户、 信使、 成员、 设置) 中谁更改了哪些内容, 首先是最新的, 有过滤器 | workspaces_history |
beryl workspaces leave | 离开你的工作空间 | workspaces_leave |
成员
管理属于工作空间的人及其角色.
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl members list | 工作空间成员列表 | 无 |
beryl members set-role <user-id> <role> | 改变成员的角色 | 无 |
beryl members remove <user-id> | 从工作空间中删除一个成员 | 无 |
邀请
发送、列出和撤销工作空间邀请,并接受发送给你的邀请.
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl invites send <email> | 通过电子邮件邀请某人到工作区 | 无 |
beryl invites list | 列出工作空间的未决邀请 | 无 |
beryl invites revoke <invitation-id> | 取消待决邀请 | 无 |
beryl invites mine | 向您发出的名单邀请 | 无 |
beryl invites accept <invitation> | 接受邀请(通过id, 或邀请邮件的代号) | 无 |
beryl invites decline <invitation-id> | 拒绝邀请 | 无 |
项目
创建和管理工程:您作者测试和运行的站点 .
beryl projects 没有子命令运行 projects list。 。 。 .
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl projects list | 列出您所有工作空间的工程, 或使用 -- 工作空间的工程 | projects_list |
beryl projects get | 显示一个项目, 包括其目前的勘探状态 | projects_get |
beryl projects create [url] | 为 URL 创建工程, 或为空的 URL 创建工程, 仅包含 -- -- name | projects_create |
beryl projects dismiss-capture-prompt | 停止提示获取此工程的签名会话 | projects_dismiss_capture_prompt |
beryl projects rename <name> | 重命名一个工程 | projects_rename |
beryl projects quarantine [state] | 打开或关闭自动隔离装置,当它变音并释放测试时调谐 | projects_quarantine |
beryl projects heal <state> | 为项目打开或关闭自愈 | projects_heal |
beryl projects surfaces [surfaces...] | 打开或关闭工程表面 | projects_surfaces |
beryl projects findings-gate <mode> | 打开每次运行的发现门 | projects_findings_gate |
beryl projects delete | 删除工程及其所有测试和运行 | projects_delete |
beryl projects re-explore | 将代理机运回运行/修复现有测试并发现新流量 | 无 |
beryl projects report | 最近各行各业的总体质量报告(通过率、每个测试历史、趋势) | projects_report |
beryl projects reusable-auth <url> | 检查保存的登录在创建工程前是否可以被重用到 URL | projects_reusable_auth |
环境
管理一个工程的环境: URL 和 Auth Beryl 运行对照测试 .
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl envs list | 列出项目的环境 | envs_list |
beryl envs get <env-id> | 显示一个环境 | envs_get |
beryl envs create <name> <url> | 在项目中添加环境(例如中转) | envs_create |
beryl envs update <env-id> | 更新环境名称、 URL、 app ids、 认证设置、 站点健康屏幕大小、 时间表、 CI 和页面, 或发布跟踪器设置 | envs_update |
beryl envs delete <env-id> | 删除环境 | envs_delete |
时间表
管理 Beryl 自动运行项目测试的时间表 。 一个项目可以拥有许多独立的时间表;每个项目都有自己的环境,cadence(每日或每周),本地运行时间,时区,以及目标群体(无一=每个活跃测试).
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl schedule list | 列出项目的时间表 | schedule_list |
beryl schedule add | 添加时间表( 每天, 或某一天每周) | schedule_add |
beryl schedule update <schedule-id> | 更改时间表的节奏、时间、时区、组或环境 | schedule_update |
beryl schedule remove <schedule-id> | 删除一个进度表( 它的测试和组保留) | schedule_remove |
测试
作者,检查,版本,并治愈一个项目的测试:检查贝里尔运行在每次运行.
beryl tests 没有子命令运行 tests list。 。 。 .
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl tests list | 列出项目的测试, 每个测试都有其平台和滚动状态 | tests_list |
beryl tests get <test-id> | 显示一个测试及其变体 | tests_get |
beryl tests plan <test-id> | 打印测试当前步骤计划( JSON) | tests_plan |
beryl tests set-plan <test-id> | 替换测试步骤计划( 创建新版本) | tests_set_plan |
beryl tests rename <test-id> <title> | 重命名测试 | tests_rename |
beryl tests add-surface <test-id...> | 创建更多表面的现有测试, 作为同一测试的变体 | tests_add_surface |
beryl tests skip-surface <test-id> | 把测试标为不是表面,所以它从来就没有被标为缺失 | tests_skip_surface |
beryl tests set-intent <test-id> <intent> | 校对:Soup | tests_set_intent |
beryl tests set-groups <test-id> | 替换组合中属于 | tests_set_groups |
beryl tests set-access <test-id> <access> | 标记一个读取或写入的测试 | tests_set_access |
beryl tests add-groups <test-ids...> | 在一个或多个测试中添加组, 保留它们已经拥有的组 | tests_add_groups |
beryl tests quarantine <state> <test-ids...> | 静态片段测试:它们持续运行,但失败停止了运行失败 | tests_quarantine |
beryl tests events <test-id> | 谁隔离、分组或重新命名测试,以及为什么 | tests_events |
beryl tests delete <test-ids...> | 删除测试及其版本历史和结果 | tests_delete |
beryl tests recompile <test-id> | 验证 + 在持续运行前对照现场核查经编辑的计划 | tests_recompile |
beryl tests versions <test-id> | 列出测试的版本历史 | tests_versions |
beryl tests version <test-id> <version-no> | 显示一个测试的特定版本( 包括其计划) | tests_version |
beryl tests diff <test-id> <from> <to> | 测试计划的两个版本 | tests_diff |
beryl tests restore <test-id> <version-no> | 将测试恢复到更早的版本 | tests_restore |
beryl tests reset <test-id> | 丢弃用户编辑并将测试返回到其最新的系统授权版本 | tests_reset |
beryl tests heal <test-id> <state> | 打开或关闭自愈测试 | tests_heal |
beryl tests history <test-id> | 考试通过/失败历史、记录和稳定性 | tests_history |
beryl tests script <test-id> | 为测试打印已渲染的 Playwright 光谱 | tests_script |
beryl tests export <test-ids...> | 导出测试为 ZIP 中的 Playwright . spec.ts 文件 | tests_export |
组
管理一个项目的测试组:给测试贴上标签,可以携带任意数量,用于过滤,运行,或安排套件的切片. 组只在这里创建( 或在设置 ~ 组中); 指定一个未知名称的测试是一个错误 .
beryl groups 没有子命令运行 groups list。 。 。 .
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl groups list | 列出项目的测试组和每个组有多少测试 | groups_list |
beryl groups create <name> | 创建组 | groups_create |
beryl groups rename <group> <name> | 重新命名一个组( 测试保留其成员) | groups_rename |
beryl groups delete <group> | 删除一组: 其测试停留; 仅针对该组的时间表随同进行 | groups_delete |
运行
触发一个项目的一跑测试(例如CI),然后观看,检查和下载结果.
beryl runs 没有子命令运行 runs list。 。 。 .
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl runs trigger | 触发测试运行( 完整套件、 子集或一个环境) | runs_trigger |
beryl runs queue | 显示飞行中的跑跑和等待它后面的跑跑 | runs_queue |
beryl runs list | 列表最近运行 | runs_list |
beryl runs get <run-id> | 显示一次运行的测试结果 | runs_get |
beryl runs watch <run-id> | 跟着跑到结束 | runs_watch |
beryl runs cancel <run-id> | 取消飞行中运行, 或从队列中取出队列 | runs_cancel |
beryl runs report <run-id> | 显示运行时生成的报表 | runs_report |
beryl runs download <run-id> | 用签名的文物 URL 获取运行结果, 或者将其下载到磁盘中 | runs_download |
beryl runs explain <result-id> | 与AI解释为什么测试结果失败 | runs_explain |
卫生
站点健康,或您站点对搜索引擎和访客的读取方式:内容,速度,链接,安全,以及手机,平板电脑和桌面大小的可视化检查布局,从对您活页的真实检查分级.
beryl health 没有子命令运行 health get。 。 。 .
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl health get | 显示最新的现场健康报告, 或者用 id 显示一个报告 | health_get |
beryl health run | 进行新的现场健康检查或一页的视觉检查 | health_run |
beryl health intended <key> | 按原意标出一个发现,所以它停止计分 | health_intended |
beryl health tracker status | 显示 Site Health 文件如何将结果作为环境问题跟踪票 | health_tracker_status |
beryl health tracker tickets | 列出结果 现场健康轨迹 及其门票 | health_tracker_tickets |
beryl health tracker connect | 获取连接问题跟踪器到工作空间的链接 | health_tracker_connect |
beryl health tracker disconnect | 删除工作空间的问题跟踪器连接 | health_tracker_disconnect |
beryl health tracker teams | 列出连接的问题跟踪器的团队 | health_tracker_teams |
beryl health tracker projects | 列出一个跟踪团队的项目 | health_tracker_projects |
任务
测试创造工作:云代理遵循一个即时,文档,或两者兼有,以及作者测试.
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl jobs create [prompt] | 在 Beryl 的云中从一个提示、一个文档或两者同时创建测试 | jobs_create |
beryl jobs list | 列出项目的测试创建工作 | jobs_list |
beryl jobs get <job-id> | 显示工作状态及其创建的测试 | jobs_get |
beryl jobs clone <job-id> | 再次运行一个任务: 以相同的提示、 文档、 环境和账户排入新任务 | jobs_clone |
beryl jobs retry <job-id> | 作者只保留了部分或失败的工作, 选择使用编辑后提示或文档 | jobs_retry |
beryl jobs cancel <job-id> | 停止队列、 运行或暂停任务; 它已经创建的测试 | jobs_cancel |
beryl jobs delete <job-id> | 删除任务; 它创建的流量和测试 | jobs_delete |
勘探
探究代理勘探运行情况:如何爬出一个站点并撰写了测试.
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl explorations list | 列出项目代理人的勘探通行证 | 无 |
beryl explorations get <exploration-id> | 显示一个探索: 作者测试、 废弃流量、 覆盖、 前沿 | 无 |
beryl explorations steps <exploration-id> | 列出代理人在勘探中采取的每一步骤 | 无 |
beryl explorations cancel <exploration-id> | 取消飞行中探索 | 无 |
beryl explorations watch <exploration-id> | 流出勘探现场:观看代理勘探和作者测试 | 无 |
配置
管理代理在探索和运行时可以使用的变量,秘密和文件.
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl config vars list | 列出工程的配置变量( 运行时可被代理机所看到) | config_vars_list |
beryl config vars set <key> <value> | 创建或更新配置变量 | config_vars_set |
beryl config vars get <key> | 显示一个配置变量 | config_vars_get |
beryl config vars delete <key> | 删除配置变量 | config_vars_delete |
beryl config secrets list | 列出项目的秘密( 数值从未返回); 测试账户的密码由账户管理, 而不是在这里 | config_secrets_list |
beryl config secrets set <key> <value> | 创建密钥( 只写; 重设密钥替换它) | config_secrets_set |
beryl config secrets get <key> | 显示一个秘密的元数据, 或以 -- reveal 显示其值 | config_secrets_get |
beryl config secrets delete <key> | 删除一个秘密 | config_secrets_delete |
beryl config signing get | Android用.aab的指纹转换出哪些关键标志 | config_signing_get |
beryl config signing set | 签名转换的 Android 用自己的密钥构建 | 无 |
beryl config signing clear | 忘了你的密钥托; 转换后的建筑返回到贝里尔的密钥 | config_signing_clear |
beryl config files list | 列出已上传的文件: 固定测试附件和 Android 和 iOS 应用程序构建 | config_files_list |
beryl config files get <file> | 显示一个上传文件的元数据 | config_files_get |
beryl config files upload <file> | 上传文件: 上传步骤附加的固定图, 或 Android 或 iOS 应用程序构建 | 无 |
beryl config files download <file-id> | 获取文件的短寿命下载 URL | config_files_download |
beryl config files delete <file-id> | 删除已上传的文件 | config_files_delete |
邮箱
该项目的站台电子邮件地址,其测试接收登录邮件.
beryl mailbox 没有子命令运行 mailbox get。 。 。 .
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl mailbox get | 项目的邮箱地址 | mailbox_get |
beryl mailbox list | 列出项目的邮箱 | mailbox_list |
beryl mailbox identities | +tag 地址为 Beryl minted 用于这个项目的测试, 以及每次清理是如何结束的 | mailbox_identities |
beryl mailbox create | 在工程中添加第二个邮箱 | mailbox_create |
beryl mailbox delete <mailbox-id> | 删除邮箱和收到的每封邮件 | mailbox_delete |
beryl mailbox read <mailbox-id> | 在邮箱中读取最新的电子邮件( 等待一个邮件到达) | mailbox_read |
beryl mailbox emails <mailbox-id> | 列出邮箱收到的电子邮件 | mailbox_emails |
第三方融入
测试一个网站自己的整合(Connect Slack) 与贝里尔在这些供应商的账户相对应.
beryl third-party-integrations 没有子命令运行 third-party-integrations list。 。 。 .
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl third-party-integrations list | 第三方提供商 这个项目的测试可以连接到 | third_party_integrations_list |
beryl third-party-integrations target | 当应用程序问到发布地点时, 此工程的测试选择的频道 | third_party_integrations_target |
账户
测试现场的持久身份:何等是经过认证的测试标志.
beryl accounts 没有子命令运行 accounts list。 。 。 .
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl accounts list | 列出测试账户中的环境测试标志为 | accounts_list |
beryl accounts get <account-id> | 显示一个测试账户:来源、寿命、登录状态 | accounts_get |
beryl accounts create | 添加一个测试账户:客户自己的账户,或者一个贝里尔签名 | accounts_create |
beryl accounts capture | 将登录的会话存储为捕获的测试账户 | accounts_capture |
beryl accounts signup <account-id> | 将你刚走过的签注作为测试账户的签注计划 | accounts_signup |
beryl accounts set-login <account-id> | 将签入计划存储一次运行重放,加上签入的支票来证明 | accounts_set_login |
beryl accounts get-login <account-id> | 阅读存储的签入计划, 其签入的支票, 和散列安全字必须引用 | accounts_get_login |
beryl accounts check <account-id> | 现在签名并证明会话能活到新浏览器中 | accounts_check |
beryl accounts update <account-id> | 更改测试账户的密码、 登录方法或默认旗帜 | accounts_update |
beryl accounts delete <account-id> | 删除测试账户 | accounts_delete |
账户
查看并更新您的个人账户配置 .
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl account get | 显示您的账户配置 | 无 |
beryl account update | 更新您的配置 | 无 |
beryl account deletion-preview | 预览删除您的账户会删除或离开的内容 | 无 |
反馈
向贝里尔团队发送产品反馈.
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl feedback send <message> | 向Beryl团队发送产品反馈 | 无 |
账单
审查工作空间的计划使用、订阅和发票;更新或切换计划.
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl billing plans | 列出计划:价格,云运行分钟,AI创建测试,活性测试,并列槽 | 无 |
beryl billing usage | 显示计划用途:云运行分钟(web 1x,Android 2x,iOS 5x),AI创建测试,可运行测试(您最新的计划运行),平行插槽,运行历史,以及包平衡 | 无 |
beryl billing checkout | 获取将自由工作空间移动到团队或商务的花旗检查链接 | 无 |
beryl billing plan | 获得一个链接,以便一个人批准在团队和企业之间转换一个每月或每年的带薪工作空间;除非他们这样做,否则不会有任何变化。 批准后,在今天收取更高一级或从月到年的费用,并重新开始周期;其他一切在下一个计费日生效 | 无 |
beryl billing subscription | 显示工作空间的订阅, 包括下等或取消等待下一个计费日 | 无 |
beryl billing invoices | 列出最近发票 | 无 |
beryl billing portal | 获取工作空间的花边计费端口链接 | 无 |
beryl billing packs buy | 获得一个链接,让一个人批准在Team或Business上购买一次性包(2,500个云运行分钟或25个人工智能创建的测试),在每月津贴后使用,并且不会过期;在他们完成之前不收取任何费用 | 无 |
beryl billing auto-refill get | 显示自动填充:它购买的包装、门槛、月上限和这一时期的开支 | 无 |
beryl billing auto-refill set | 获取一个链接, 一个人可以批准自动重填或关闭; 除非它们改变 。 当:一旦津贴用完,当其余额低于门槛值时,购买一个包,最多可选的月上限;留出旗帜,保留其现值 | 无 |
beryl billing addons get | 显示工作空间的每月加价( 超平行插槽, 100 额外可运行测试) , 其价格和任何等待计费日的减价 | 无 |
beryl billing addons set | 获得一个链接让一个人在团队或商业上每月批准加注;除非他们这样做,否则没有什么变化. 批准后,今天收取更多的费用,按比例分配给计费日;减少在计费日生效,不退款. 每月在自己的发票上加帐单,也是在年度计划上加帐;旗帜保留其现值 | 无 |
版本
显示运行的 CLI 版本、 API URL 和节点版本
| 命令 | 内容提要 | MCP 工具 |
|---|---|---|
beryl version | 显示运行的 CLI 版本、 API URL 和节点版本 | version |
运行 beryl <command> --help 旗帜和例子.
全球旗帜
-V, --version: 打印 CLI 版本并退出--json: 打印机可读 JSON( NDJSON 为流)--api-url: API 基础 URL( 默认) https://api.beryl.so (英语)(中文(简体) )--token: 个人访问符(覆盖配置/BERYL API KEY)-h, --help: 显示帮助