> ## Documentation Index
> Fetch the complete documentation index at: https://docs.molesignal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 命令参考

> MoleSignal 命令行的全部命令、子命令与选项，以及环境变量与退出码。

`molesignal <命令> --help` 输出单个命令的同样内容。

## 每个命令都接受的选项

每个与 MoleSignal 通信的命令都接受以下选项：

| 选项 | 含义 |
| - | - |
| `--profile <名称>` | 使用哪个保存的登录。参见[保存多个登录](https://docs.molesignal.com/zh-Hans/cli/sign-in.md#保存多个登录)。 |
| `--url <地址>` | MoleSignal 地址，代替 profile 中的地址。 |
| `--token <token>` | 只对这个命令生效的 API Token。 |

时间可以写成 ISO 时间、本地时间 `2026-10-26 14:00`、自 Unix 纪元起的秒数、毫秒数或微秒数，或往前推的时长。时长由数字和单位组成：`ms`、`s`、`m`、`h`、`d` 或 `w`。

## 登录

| 命令 | 选项 | 说明 |
| - | - | - |
| `login` | `--url <地址>`、`--profile <名称>`、`--with-token` | 在浏览器中登录，或用从标准输入读取的 API Token 登录。该 profile 成为当前 profile。 |
| `logout` | `--profile <名称>` | 删除一个 profile 的登录，保留其地址。 |
| `profiles` | `--json` | 列出 profile。`profiles remove <名称>` 删除一个。 |
| `use <profile>` | 无 | 把一个 profile 设为当前 profile。 |
| `status` | 无 | 显示地址、profile、服务器、MCP 协议版本、登录方式和工具数。 |
| `whoami` | `--json` | 显示用户、组织、角色和权限。 |
| `doctor` | 无 | 检查 Node.js、配置、地址、代理、网络与 TLS、时钟、登录和 MCP 端点。 |

## 日志与查询

| 命令 | 选项 | 说明 |
| - | - | - |
| `streams` | `--type <类型>`、`--names`、`--json` | 列出某一类型的数据流，默认 `logs`。 |
| `logs <数据流>` | `-f`、`-n`、`-q`、`--where`、`--since`、`--from`、`--to`、`--fields`、`--around`、`-B`、`-A`、`--interval`、`--json`、`--utc`、`--web` | 输出数据流最新的日志；`-f` 持续输出新日志。参见[查看与跟随日志](https://docs.molesignal.com/zh-Hans/cli/logs.md)。 |
| `query "<SQL>"` | `--stream`、`--since`、`--from`、`--to`、`-n`、`--csv`、`--json`、`--utc`、`--web` | 对日志数据流执行一条只读 SQL。 |
| `fields <数据流> [字段]` | `--type`、`--since`、`--from`、`--to`、`-n`、`--match`、`--json` | 列出数据流的字段，或某个字段最常见的值。 |

### `logs` 的选项

| 选项 | 默认值 | 含义 |
| - | - | - |
| `-f`、`--follow` | 关闭 | 持续输出新日志，直到按 **Ctrl+C**。 |
| `-n`、`--lines <数量>` | `100` | 先输出多少条最新的日志，`1` 到 `5000`。 |
| `-q`、`--query <查询>` | 无 | 字段查询，写法与 **日志** 页面相同。 |
| `--where <条件>` | 无 | 针对数据流字段的 SQL 条件。 |
| `--since <时长>` | `15m` | 往前看多久。 |
| `--from <时间>`、`--to <时间>` | 无 | 代替 `--since` 的时间窗。`--to` 不能与 `-f` 一起使用。 |
| `--fields <a,b,c>` | 全部 | 只输出时间和这些字段。 |
| `--around <时间>` | 无 | 输出某一时刻前后紧挨着的日志。 |
| `-B`、`--before <数量>` | `10` | 与 `--around` 一起使用：之前多少条，最多 `250`。 |
| `-A`、`--after <数量>` | `10` | 与 `--around` 一起使用：之后多少条，最多 `250`。 |
| `--interval <时长>` | `2s` | 跟随时多久读取一次。 |
| `--json` | 关闭 | 每条日志输出一行 JSON。 |
| `--utc` | 关闭 | 以 UTC 显示时间。 |
| `--web` | 关闭 | 在 **日志** 页面打开，而不是输出。 |

## 指标、链路与服务

| 命令 | 选项 | 说明 |
| - | - | - |
| `metrics query '<PromQL>'` | `--since`、`--from`、`--to`、`-n`、`--csv`、`--json` | 执行 PromQL 区间查询，每个序列一行并带迷你折线。 |
| `metrics names [文本]`、`metrics labels <指标>`、`metrics values <指标> <标签>`、`metrics series <指标>` | `-n`、`--match <标签=值>`、`--json` | 列出指标名称、标签、标签取值和序列。 |
| `traces` | `--service`、`--errors`、`--min-duration`、`--since`、`--from`、`--to`、`-n`、`--json` | 列出最近的链路。 |
| `traces show <链路>` | `--since`、`--from`、`--to`、`--json`、`--web` | 把一条链路画成瀑布图。 |
| `services` | `--env`、`--namespace`、`--sort`、`--since`、`--from`、`--to`、`-n`、`--json` | 列出 APM 服务及其健康状态。 |
| `services show <服务>` | `--env`、`--namespace`、`--since`、`--json`、`--web` | 汇总一个服务。 |
| `services compare <服务> <基线版本> <候选版本>` | `--env`、`--since`、`--fail-on-regression`、`--json` | 比较两个版本。 |
| `search-jobs` | `-n`、`--json` | 列出搜索任务。 |
| `search-jobs submit "<语句>"` | `--stream`、`--type`、`--promql`、`--step`、`--since`、`--from`、`--to`、`--limit`、`--keep`、`--wait`、变更选项 | 提交搜索任务。 |
| `search-jobs show <任务>`、`search-jobs results <任务>`、`search-jobs cancel <任务>` | `-o <文件>`、`--csv`、`--json`、变更选项 | 查看任务、写出结果或取消任务。 |

## 值班与变更

| 命令 | 选项 | 说明 |
| - | - | - |
| `incidents` | `--status`、`--since`、`-n`、`--json` | 列出事件，默认进行中的事件。 |
| `incidents show <事件>` | `--rca`、`--json`、`--web` | 输出一个事件。 |
| `incidents ack <事件>`、`incidents resolve <事件>` | 变更选项 | 确认或解决一个事件。 |
| `oncall` | `--schedule`、`--at`、`--json` | 显示谁在值班。 |
| `approvals` | `--all`、`-n`、`--json` | 列出等待中或已批准的审批请求。 |
| `approvals show <审批>`、`approvals execute <审批>` | `--json`、变更选项 | 输出一个请求，或执行已批准的变更。 |
| `annotate "<标题>"` | `--description`、`--tags`、`--dashboard`、`--stream`、`--time`、`--end`、变更选项 | 为大盘添加标注。 |
| `synthetics` | `--lifecycle`、`--json` | 列出拨测检查。 |
| `synthetics results <检查>` | `--since`、`-n`、`--json` | 列出一个检查最近的运行结果。 |
| `synthetics run <检查>` | 变更选项 | 立即运行一个检查；带 `--wait` 时等待运行结果。 |

变更选项如下，参见[变更如何执行](https://docs.molesignal.com/zh-Hans/cli/changes.md#变更如何执行)。

| 选项 | 含义 |
| - | - |
| `--reason <文本>` | 原因，随审批保存并写入审计日志。 |
| `--wait` | 变更需要审批时等待审批，批准后执行变更。 |
| `--timeout <时长>` | `--wait` 最长等待多久，默认 `30m`，`synthetics run` 默认 `10m`。 |
| `-y`、`--yes` | MoleSignal 要求确认变更时直接确认。 |

## 发布与数据

以下命令需要 API Token，参见[CI 与发布](https://docs.molesignal.com/zh-Hans/cli/ci.md)。

| 命令 | 选项 | 说明 |
| - | - | - |
| `deploy` | `--service`、`--version`、`--env`、`--namespace`、`--kind`、`--status`、`--commit`、`--repository`、`--pull-request`、`--author`、`--ci-url`、`--description`、`--time`、`--dry-run`、`-- <命令>` | 记录一次发布。 |
| `source-maps upload <路径>…` | `--application`、`--service`、`--release`、`--platform`、`--arch`、`--debug-id`、`--concurrency`、`--dry-run` | 上传 JavaScript Source Map。 |
| `symbols upload <路径>…` | `--application`、`--service`、`--release`、`--platform`、`--arch`、`--debug-id`、`--concurrency`、`--dry-run` | 上传 Flutter、Android 和 Apple 符号。 |
| `source-maps list`、`symbols list` | `--application`、`--service`、`--release`、`--platform`、`--kind`、`--json` | 列出已上传的文件。 |
| `source-maps delete <ID>`、`symbols delete <ID>` | 无 | 删除一个已上传的文件。 |
| `send <数据流>` | `--field <名称=值>`、`--raw`、`--batch` | 把标准输入的每一行发到日志数据流。 |
| `run <数据流> -- <命令>` | `--name`、`--field <名称=值>`、`--quiet` | 运行一个命令，把它的输出和退出码发到日志数据流。 |

## 工具与设置

| 命令 | 选项 | 说明 |
| - | - | - |
| `tools [词…]` | `--domain`、`--json` | 列出用户能调用的工具。`tools show <工具>` 输出一个工具及其参数。 |
| `call <工具> [名称=值…]` | `--input`、`--since`、`--from`、`--to`、变更选项 | 调用一个工具，以 JSON 输出结果。 |
| `mcp` | 无 | 通过 stdio 提供 MoleSignal 的 MCP 工具。 |
| `mcp setup <工具>` | `--scope`、`--installed`、`--print` | 把服务器添加到 `claude`、`cursor`、`codex`、`vscode` 或 `gemini`。 |
| `open [页面] [ID]` | `--print` | 在浏览器中打开 MoleSignal 页面。 |
| `completion <shell>` | 无 | 输出 `bash`、`zsh` 或 `fish` 的补全脚本。 |
| `--help`、`--version` | 无 | 输出帮助或版本。 |

## 环境变量

| 变量 | 含义 |
| - | - |
| `MOLESIGNAL_URL` | MoleSignal 地址，代替 `--url` 或保存的地址。 |
| `MOLESIGNAL_TOKEN` | API Token，代替保存的登录。 |
| `MOLESIGNAL_PROFILE` | 使用的 profile，代替当前 profile。 |
| `MOLESIGNAL_CONFIG` | 保存 profile 的文件。默认 `~/.config/molesignal/config.json`。 |
| `HTTPS_PROXY`、`HTTP_PROXY` | 每个请求经过的代理。 |
| `NO_PROXY` | 不经过代理直接访问的主机。 |
| `NODE_EXTRA_CA_CERTS` | 系统之外额外信任的证书颁发机构。 |
| `NO_COLOR` | 输出不带颜色。 |
| `FORCE_COLOR` | 输出不是终端时也带颜色。 |

选项优先于环境变量，环境变量优先于保存的 profile。

## 退出码

| 退出码 | 含义 |
| - | - |
| `0` | 命令成功，或跟随被停止。 |
| `1` | 命令失败，原因输出到标准错误。以下情况也是 `1`：带 `--wait` 的拨测运行失败、带 `--fail-on-regression` 时版本变差、`send` 的日志被拒绝、`doctor` 有检查未通过。 |
| `2` | 未知的命令、选项或参数。 |
| `3` | 变更在等待审批，尚未执行。 |

`deploy -- <命令>` 与 `run` 以所运行命令的退出码退出。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.