安装 SocQ CLI
安装已发布的 @socq/cli 软件包，让终端可以直接使用 socq 命令。
专为开发者与自动化工作流打造的跨平台公开社交数据 CLI.
通过一套命令连接多个公开社交平台，发现实时 API 目录、提交采集、持续完成异步任务，并将标准化结果直接交给 Shell 脚本、CI 和数据分析流程。
Node.js 20+实时 Capability Registry12 个平台92 个 API Endpoint
快速开始
三步完成第一次公开社交数据采集
安装 SocQ CLI、安全保存 API Key，再运行一个与 SocQ 文档、MCP 和 REST 使用相同定义的 Endpoint。
配置 API Key
将 API Key 保存到系统 Keyring 或受保护的本地配置中。
提交第一个任务
运行 YouTube 评论 Endpoint，并持续读取标准化结果。
在 CI 中通过 Secret Manager 提供 SOCQ_API_KEY，让凭证在自动化运行中保持安全。
查看完整 CLI 指南CLI 能做什么
选择当前任务需要的 CLI 命令
浏览 API、提交采集、查询已有任务或导出结果。四类命令均可独立使用，也可以按实际工作流组合到本地终端、Shell 脚本和自动化流水线中。
可独立使用的命令示例
$ socq tools youtube从实时 Capability Registry 浏览当前 YouTube Endpoint。
真实命令示例
复制命令，开始采集公开社交数据
这六个示例使用当前 SocQ Endpoint ID 和已接受的输入字段，每条命令都可以直接复制并按工作流调整。
YouTube Comments API
Endpoint: youtube/comments采集公开可见的 YouTube 评论并等待标准化结果。
Twitter Search API
Endpoint: x/search根据搜索条件构建公开 X 帖子数据集。
TikTok Search API
Endpoint: tiktok/search搜索公开 TikTok 视频并导出标准化记录。
Instagram Comments API
Endpoint: instagram/comments从指定 Instagram 帖子 URL 采集公开评论。
Facebook Ad Library Search API
Endpoint: facebook-ad-library/search根据关键词搜索 Facebook Ad Library 公开广告素材。
LinkedIn Jobs API
Endpoint: linkedin/jobs将公开 LinkedIn 职位页面整理成结构化职位字段。
CLI 如何工作
一次提交，持续获取完整结果
SocQ CLI 将采集请求提交为后台任务并返回 task_id。你可以使用 --wait 在当前命令中等待，也可以保留 task_id 稍后恢复；任务完成后读取标准化结果或获取原始文件。
- 01
提交采集请求
运行平台和资源命令，CLI 将请求提交为后台任务。
- 02
返回 task_id
CLI 返回唯一任务标识，用于等待、恢复和读取结果。
- 03
当前等待或稍后恢复
使用 --wait 继续等待，或在之后通过 task_id 恢复同一任务。
- 04
读取结果或获取文件
任务成功后导出标准化结果，并按需查看可用文件。
CLI 执行流程
01 / 提交采集请求
运行对应平台和资源的命令，CLI 会把采集请求提交为后台任务。
task_id: TASK_ID提交后 CLI 返回该任务的唯一 task_id。
为什么选择 SocQ CLI
一套命令，从本地采集到自动化流水线
SocQ CLI 将实时 API 目录、异步任务控制和标准化结果带进终端。先在本地验证命令，再接入 Shell 脚本和自动化流水线，无需为不同平台维护多套采集脚本。
API 能力更新，命令同步可用
平台、Endpoint、输入 Schema 和计费说明来自实时 Capability Registry，无需维护另一份固定命令清单。
LIVE REGISTRY → CURRENT COMMANDS
本地验证后，直接进入自动化
JSON、JSONL、CSV 和 table 输出配合文件导出与明确退出码，让同一套命令稳定运行在 Shell 脚本和自动化流水线中。
JSON · JSONL · CSV · EXIT CODES
任务中断，也能从原处继续
保留 task_id 即可在超时或进程中断后恢复同一任务，继续读取分页结果和文件，避免重复提交与重复采集。
SUBMIT → TASK_ID → RESUME → RESULTS
选择接入方式
你的工作流，应该从哪里接入 SocQ？
MCP、CLI 和 REST 是执行入口，Agent Skill 是增强层。它们共用同一套 API 目录与异步任务模型，能力一致，接入自由。
把 SocQ 带进终端和自动化流水线
使用一套命令发现 API、提交采集、恢复异步任务，并将标准化结果直接导出到文件和自动化流程。
- 适合
- 开发者、Shell 脚本和自动化流水线
- 使用方式
- socq 命令 + 结构化输出
- 下一步
- 安装并运行 SocQ CLI
可选增强 · Agent Skill
Agent Skill
为 Agent 补充 Endpoint 选择、成本控制、分页和任务恢复方法。优先配合 MCP，也可以通过 CLI 或 REST 执行。
CLI 常见问题
常见问题
SocQ CLI 是什么？
SocQ CLI 是 SocQ 的命令行工具。你可以在终端中发现和调用 SocQ API、提交公开社交数据采集任务、等待或恢复异步任务，并将标准化结果导出到文件、脚本和自动化流水线。
什么情况下应该使用 SocQ CLI？
终端操作、Shell 脚本、自动化流水线、批量采集和文件导出适合使用 CLI。需要 AI 客户端直接发现并调用工具时使用 MCP；需要在应用中长期集成时使用 REST API。
SocQ CLI 是否支持完整的 SocQ API 目录？
是。CLI 从实时 Capability Registry 读取当前平台、Endpoint、输入 Schema 和计费说明，可用命令会随 SocQ API 目录更新。你可以使用 socq platforms、socq tools 和 socq describe 查看当前能力。
需要全局安装 SocQ CLI 吗？
不一定。经常使用时可以全局安装 @socq/cli，让 socq 命令随时可用；偶尔运行命令或先浏览 API 目录时，可以直接使用 npx @socq/cli。
使用 SocQ CLI 需要 API Key 吗？
浏览公开 Capability Registry 不需要 API Key；提交采集、查询账户以及读取任务和文件时需要。日常使用可通过 socq auth login 配置，自动化流水线应通过 Secret Manager 提供 SOCQ_API_KEY。
等待超时后，采集任务会被取消吗？
不会。本地等待超时不会取消服务端任务。保留 task_id，再次运行 socq task get 或 socq task wait 即可继续同一任务，无需重新提交采集。
SocQ CLI 支持哪些输出格式？
支持 table、JSON、JSONL 和 CSV。你可以直接在终端查看少量结果，也可以使用 --output 将标准化结果写入文件，交给脚本、电子表格或数据分析流程。
SocQ CLI 支持哪些系统和运行环境？
SocQ CLI 需要 Node.js 20 或更高版本，支持 Windows、macOS 和 Linux。