Back to Details

meticulous-cli

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Meticulous CLI

Meticulous CLI

The 
meticulous
CLI records user sessions and replays them to catch visual regressions. It is installed as part of 
@alwaysmeticulous/cli
.
Before starting, run the 
meticulous-cli-update
skill to ensure the Meticulous CLI is up to date — unless it has already run earlier in this conversation, in which case skip it.
Meticulous CLI 用于录制用户会话并回放，以捕获视觉回归问题。它作为
@alwaysmeticulous/cli
的一部分进行安装。
开始之前，请运行
meticulous-cli-update
技能以确保Meticulous CLI是最新版本——除非在本次对话中已经运行过该技能，否则请跳过此步骤。

Invocation

调用方式

bash
meticulous <command> [options]
The skills assume 
meticulous
is on 
PATH
. The 
meticulous-cli-update
skill installs it globally via 
npm install --global @alwaysmeticulous/cli@latest
if missing. It can also be invoked as 
npx @alwaysmeticulous/cli
when installed locally per-project.
bash
meticulous <command> [options]
技能默认
meticulous
已在
PATH
中。如果未安装，
meticulous-cli-update
技能会通过
npm install --global @alwaysmeticulous/cli@latest
全局安装它。当按项目本地安装时，也可以通过
npx @alwaysmeticulous/cli
调用它。

Command Groups

命令组

CommandPurpose
auth
Authenticate with Meticulous (whoami, logout)
debug
Set up AI-ready debug workspaces for investigating replay diffs and replays
download
Download sessions, replays, and test runs locally
local
Find sessions relevant to the current branch's code changes
project
Inspect the project linked to an API token
simulate
/ 
replay
Replay a recorded session against a URL
schema
Output the CLI command schema as JSON (for agent/programmatic use)
See the reference for each group for full option details:
  • references/auth.md
  • references/debug.md
  • references/download.md
  • references/local.md
  • references/project.md
  • references/simulate.md
  • references/schema.md
命令用途
auth
登录Meticulous系统（查看当前用户、登出）
debug
设置支持AI的调试工作区，用于调查回放差异和回放问题
download
将会话、回放和测试运行结果下载到本地
local
查找与当前分支代码变更相关的会话
project
查看与API令牌关联的项目信息
simulate
/ 
replay
针对指定URL回放录制的会话
schema
以JSON格式输出CLI命令的架构（供Agent/程序化调用使用）
查看每个命令组的参考文档以获取完整的选项详情：
  • references/auth.md
  • references/debug.md
  • references/download.md
  • references/local.md
  • references/project.md
  • references/simulate.md
  • references/schema.md

Global Options

全局选项

These options are accepted by every command:
OptionTypeDefaultDescription
--logLevel
string
info
Log verbosity: 
trace
, 
debug
, 
info
, 
warn
, 
error
, 
silent
--dataDir
string
~/.meticulous
Directory where sessions, replays, and other data are stored
--rawJson
string—Pass all options as a JSON string (useful for programmatic/agent invocation)
--dryRun
boolean
false
Print what the command would do without making any changes
以下选项适用于所有命令：
选项类型默认值描述
--logLevel
string
info
日志详细程度：
trace
、
debug
、
info
、
warn
、
error
、
silent
--dataDir
string
~/.meticulous
存储会话、回放及其他数据的目录
--rawJson
string—以JSON字符串形式传递所有选项（适用于程序化/Agent调用）
--dryRun
boolean
false
打印命令将执行的操作，但不实际进行任何更改

API Token

API令牌

Most commands require an API token, passed via 
--apiToken
or the 
METICULOUS_API_TOKEN
environment variable. The token is scoped to a specific organization/project.
大多数命令需要API令牌，可通过
--apiToken
参数或
METICULOUS_API_TOKEN
环境变量传递。令牌针对特定组织/项目生效。

Example

示例

bash
undefined
bash
undefined

Print schema for all commands (agent use)

输出所有命令的架构（供Agent使用）

meticulous schema
meticulous schema

Run a single replay locally

在本地运行单次回放

meticulous simulate --sessionId=<id> --appUrl=http://localhost:3000
undefined
meticulous simulate --sessionId=<id> --appUrl=http://localhost:3000
undefined