跳转到主要内容
八爪鱼 CLI 常用命令一览。尖括号 <taskId><apiKey><url> 表示需替换为实际值。
除特别说明外,功能命令均需先完成 octopus auth login。脚本、CI、Codex 或 Agent 调用时优先使用 --json / --jsonl

帮助与诊断

octopus --help
octopus --version
octopus capabilities
octopus doctor
octopus browser doctor

octopus capabilities --json
octopus doctor --json

认证

octopus auth login
octopus auth login --oauth
octopus auth login <apiKey>
octopus auth login --stdin
octopus auth login --no-open
octopus auth status
octopus auth status --json
octopus auth logout
环境变量:
OCTOPUS_API_KEY=<apiKey> octopus task list --json
OCTOPUS_ACCESS_TOKEN=<accessToken> octopus task list --json
octopus task list --api-base-url https://example.com --json

网页检测与任务生成

octopus detect <url>
octopus detect <url> --agent --agent-command "node make-plan.mjs" --goal "提取商品信息" --yes --run-sample 5 --json
octopus detect <url> --agent --agent-command "node make-plan.mjs" --goal "提取商品信息" --yes --run-sample 5 --run-output ./sample-runs --keep-agent-files --json
Agent 审计流程:
octopus detect <url> --prepare-agent --json --goal "提取用户评论" --output context.json
octopus detect --preview-agent-plan plan.json --agent-context context.json --json
octopus detect --apply-agent-plan plan.json --agent-context context.json --output task.json --json
用户直接操作 CLI:
octopus detect <url> --auto --output task.json
octopus detect <url> --manual --output task.json
octopus detect <url> --auto --goal "提取商品评论" --output task.json
octopus detect <url> --auto --goal "提取商品信息" --llm-rank --output task.json
octopus detect <url> --auto --no-dismiss-popups --output task.json
octopus detect <url> --select protected_smart_1 --output task.json
octopus detect <url> --auto --query "烤面包机" --output task.json
octopus detect <url> --manual --save-session --session-name shop --output task.json
--agent-command 必须是可信的本地 shell 命令;自然语言目标使用 --goal--run-sample 只支持 --agent,且参数必须是正整数。

任务

octopus task list
octopus task list --page 2 --page-size 20
octopus task list --limit 10
octopus task list --keyword 关键词
octopus task inspect <taskId>
octopus task validate <taskId>
使用本地任务文件:
octopus task inspect <taskId> --task-file <file.json|file.xml|file.otd>
octopus task validate <taskId> --task-file <file.json|file.xml|file.otd>

本地采集

octopus run <taskId>
octopus run <taskId> --headless
octopus run <taskId> --max-rows 100
octopus run <taskId> --detach
octopus run <taskId> --output ./runs
octopus run <taskId> --chrome-path /path/to/chrome

octopus run <taskId> --task-file ./task.json --output ./results/
octopus run <taskId> --task-file ./task.json --detach --max-rows 100

云采集

octopus cloud start <taskId>
octopus cloud stop <taskId>
octopus cloud status <taskId>
octopus cloud history <taskId>

本地运行控制

octopus local status <taskId>
octopus local status <taskId> --output ./runs
octopus local pause <taskId>
octopus local resume <taskId>
octopus local stop <taskId>
octopus local history <taskId>
octopus local cleanup

数据历史与导出

octopus data history <taskId>
octopus data history <taskId> --local
octopus data history <taskId> --cloud

octopus data export <taskId> --format xlsx --file result.xlsx
octopus data export <taskId> --local --format csv --file result.csv
octopus data export <taskId> --lot-id <lotId> --format json
导出格式:xlsxcsvhtmljsonxml

任务文件结构(参考)

{
  "taskId": "abc123",
  "taskName": "示例任务",
  "xml": "... OTD XML ...",
  "xoml": "... BPMN XOML ...",
  "fieldNames": ["title", "url"],
  "workflowSetting": {},
  "brokerSettings": {},
  "userAgent": "Mozilla/5.0 ...",
  "disableAD": false
}