跳到主要内容

CLI

Gety 自带命令行工具,可以在终端中搜索文件、获取文档内容和管理连接器。

设置

  1. 打开 Gety → 设置 → AI 集成,在 更多方式 下点击 CLI 命令

Gety AI 集成 页面,显示 更多方式 下的 CLI 命令 Gety → 设置 → AI 集成:点击 更多方式 下的 CLI 命令

  1. Gety 会将 gety 命令安装到你的 PATH 中,并显示 CLI 文档。你可以浏览各个命令,或点击 复制全部 复制完整文档。

Gety CLI 文档对话框,显示命令和选项 你的 CLI 文档 — 点击 复制全部 复制全部内容

重启终端

开启 CLI 命令 后,你必须关闭并重新打开终端(或新建一个终端会话),PATH 更改才会生效。在此之前 gety 命令将无法识别。

搜索

gety search "合同续签条款"

搜索结果显示文档标题、匹配片段和文件路径。

选项

gety search "预算报告" --limit 5              # 限制结果数
gety search "会议纪要" --ext pdf --ext docx # 按文件类型过滤
gety search "Q1 营收" --json # JSON 输出
gety search "设计规范" --no-semantic-search # 仅关键词搜索
gety search "contract" --match-scope content # 仅搜索内容
参数说明
-n, --limit <n>最大结果数(默认:10)
--offset <n>分页偏移(默认:0)
-c, --connector <name>按连接器过滤(可重复)
-e, --ext <ext>按文件扩展名过滤(可重复)
--match-scope <scope>titlecontentsemantic
--sort-by <field>defaultupdate_time
--sort-order <order>ascendingdescending
--update-time-from <iso8601>按修改时间过滤
--update-time-to <iso8601>按修改时间过滤
--no-semantic-search禁用语义搜索
--json以 JSON 格式输出

获取文档

gety doc <connector_id> <doc_id>

获取文档的完整内容。connector_iddoc_id 在搜索结果中返回。

管理连接器

gety connector list                           # 列出所有已索引的文件夹
gety connector add ~/Documents # 添加文件夹到索引
gety connector add ~/Projects --name work # 添加并自定义名称
gety connector remove <connector_id> # 移除文件夹

配合 AI agent 使用

CLI 适用于能运行 shell 命令的 AI agent(如 Claude Code、Codex)。Agent 可以在执行任务时调用 gety search 查找相关文件。

给 agent 的示例提示:

"使用 gety search 搜索我本地文件中与客户提案相关的文档,然后总结要点。"

如果需要 agent 更方便地解析输出,使用 JSON 格式:

gety search "客户提案" --json
交给 AI agent

API 一样,你可以复制完整的 CLI 文档粘贴到 agent 的对话中。Agent 会知道如何替你调用 gety 命令。

退出码

退出码含义
0成功
1一般错误
2参数无效
69Gety 未运行
77额度已用完

如果返回退出码 69,请确认 Gety 桌面应用正在运行。