Skip to main content

CLI

使用 SocQ CLI 在终端中运行或自动执行数据采集任务,并将标准化结果导出为 JSON、JSONL、CSV 或表格。

安装并验证

对于 CI,设置 SOCQ_API_KEY 而不是使用交互式登录。在正常终端使用中避免使用 --api-key,因为命令参数可能保留在 shell 历史记录或进程列表中。

查找 API

编写自动化脚本前,请先运行 describe,查看能力目录中最新的输入参数和计费信息。

完成首次采集

动态命令直接映射到:
当输入来自文件时,使用稳定的通用形式:

恢复而不重新提交

如果命令在采集完成之前返回,请保留任务 ID:
任务结果统一使用固定资源 Schema,可通过 --result-fields 获取更小的字段投影。 不要因为本地等待超时就重新提交采集请求,请继续查询现有任务。

标记 Agent Skill 执行来源

普通 CLI 提交会记录为 request_source="cli"。当 Agent Skill 改用 CLI 执行时,请在提交命令中加入来源标记:
设置 SOCQ_REQUEST_SOURCE=skill 也有相同效果。新任务会记录为 skill-cli;轮询任务时不需要添加此标记。

输出格式