yoyoboot repo search

需要机器可读的源码文本命中时使用，返回路径、行号和片段。rg 适合快速精确定位，本命令额外遵守统一检索读取策略。

基本用法

yoyoboot repo search <query> [options] [--json]

在 YoyoBoot 源码仓库中运行

检索管理端现有源码，返回行号。

pnpm --dir tools/yoyoboot-cli run cli -- repo search measuringUnit --path apps/yoyo-admin --json

参数

参数	必填	说明
query	是	查询文本或符号。
--path <value>	否	源码搜索范围，不改变读取授权范围。
--limit <value>	否	结果数量上限。
--glob <value>	否	文件过滤模式。
--json	否	以 JSON 输出完整结果信封，供机器读取。
--help	否	展示帮助；yoyoboot --help / yoyoboot <command> --help。
--repo <path>	否	显式指定仓库查找起点；缺省从当前工作目录向上查找。
--regex	否	布尔选项，不接受取值。

示例

固定示例仓库中的返回结果

yoyoboot repo search service --path packages/example/src --json

此命令针对固定示例仓库。下面只展示公开字段投影，不是当前 checkout 的完整输出。

{
  "command": "repo search",
  "status": "ok",
  "data": {
    "schemaVersion": "1.0.0",
    "matches": [
      {
        "path": "packages/example/src/service.ts",
        "line": 1,
        "text": "export const service = 1"
      }
    ],
    "matchCount": 1,
    "truncated": false,
    "engine": "<search-engine>"
  }
}

返回结果

当前工作树的受策略约束搜索结果。

主要字段

字段	说明
command	实际结果命令名；Admin 保留子命令名，入口捕获异常时为 cli。
status	ok / warn / error；同时检查退出码及诊断码。warn 可以退出 0。
findings[]	诊断项包含 code、status、message，可选 detail；机器使用 code 分支，不解析消息。
source	JSON 顶层命令实现来源，包含 kind / path / owner。
data	命令结果；入口捕获失败时可能缺省，部分诊断失败仍保留结果。
data.schemaVersion	结果合同版本：1.0.0。
data.matches[]	{ path, line, text }；line 从 1 开始，片段可能被截断或脱敏。
data.matchCount	返回命中数量，等于 matches 长度，不是全库命中总数。
data.truncated	是否达到搜索输出限制；false 也不表示检索了被忽略的内容。
data.engine	ripgrep / node；引擎可用性不同，匹配行为不保证完全相同。

使用说明

• 仓库根使用 pnpm --dir tools/yoyoboot-cli run cli -- <命令参数>；已完成构建时也可使用 node tools/yoyoboot-cli/dist/bin.js <命令参数>。
• JSON 示例来自固定示例仓库的公开投影，省略实现来源、规则文件位置及大段内容；<...> 是明确的环境占位符。完整字段见返回结果表，实际内容以当前工作树为准。
• 全局参数严格解析：未知、重复、缺值参数返回退出码 2；--help 输出文本，即使同时指定 --json。
• limit 默认 50，范围 1..200；--glob 为单个文件模式，--regex 开启正则。无命中返回空 matches 与成功状态。
• 依赖、产物、敏感路径和自定义忽略保持排除。显式 reference 范围可检索被 Git 忽略的参考源码；不因此开放其它忽略目录。
• --path 缩小检索范围，不改变读取授权。查询只读；不支持 --dry-run。

退出码

Exit code	含义
0	成功或仅有警告；警告仍需阅读。
2	预期失败：参数、仓库或领域条件不满足，或严格检查未通过。
1	未预期程序错误。

常见错误

invalid-query

查询少于两个字符或参数数量错误。

处理方式：提供一个至少两个字符的查询。

invalid-limit

limit 不在范围内。

处理方式：使用 1..200 的整数。

相关命令

• yoyoboot repo context

• yoyoboot repo owner

• Reference 合同版本：1.0.0

• 结果合同版本：1.0.0

• 源码产品版本：10.5.7（不代表 registry 发布状态）。