ASP CLI

ASP CLI 提供 asp 命令，用于让分析师、自动化脚本和 Harness Agent 通过命令行访问 ASP。它可以执行认证、资源查询、评论与文件操作、Playbook 运行、SIEM 查询、威胁情报和 CMDB 查询等常用任务，也是 Skills 调用 ASP Agent Operations API 的稳定边界。

安装

先安装 pipx。

macOS

brew install pipx
pipx ensurepath

Linux

python3 -m pip install --user pipx
python3 -m pipx ensurepath

Windows

scoop install pipx
pipx ensurepath

更多安装方式见 pipx 完整文档。

推荐使用 pipx 安装：

pipx install asp-cli

更新

更新到最新版本：

pipx upgrade asp-cli

安装或回退到指定版本：

pipx install asp-cli==0.5.0 --force

安装后可以查看版本和帮助：

asp --help

登录与验证

使用 ASP 地址和个人 API Key 登录：

asp auth login --api-url https://asp.example.com --api-key asp_xxx

验证当前配置和服务连通性：

asp doctor --output json

输出格式

CLI 默认输出适合人工阅读；用于脚本、自动化和 Skills 时，建议显式使用 JSON 输出：

asp case list --output json

常用功能

场景	常用命令	用途
认证和配置	asp auth status、asp doctor	查看当前登录状态并检查服务连通性。
Case / Alert / Artifact	asp case list、asp case show case_000001 --include-related、asp alert list、asp artifact show artifact_000001	查询核心调查对象、关联 Alert 和直接 Case 关系摘要。
Comment / File	asp comment list case_000001、asp comment add case_000001 --body "..."、asp file upload ./evidence.txt、asp file read-text <file_key>	读取讨论、追加评论、上传或读取附件。
Playbook	asp playbook template list、asp playbook run investigation case_000001 --user-input "..."	查看可运行模板并触发 Case 自动化任务。
SIEM	asp siem schema list、asp siem search keyword "powershell" --from 2026-07-01T00:00:00Z --to 2026-07-02T00:00:00Z、`asp siem query spl "index=main	head 10" --from ... --to ...`
Threat Intelligence / CMDB	asp ti query 8.8.8.8 --artifact-type "IP Address" --provider OpenCTI、asp cmdb lookup IP 10.0.0.5	查询 IOC 威胁情报和资产上下文。
Knowledge / Enrichment	asp knowledge search phishing、asp enrichment create artifact_000001 --name "TI result" --value malicious	检索知识库或写入结构化富化结果。

查看直接关联 Case

asp case show case_000001 --include-related --output json

JSON 中的 relationships 最多包含 50 条直接关系摘要，不会递归展开对端 Case。CLI 当前不提供关系创建、修改、删除或 Artifact 候选查询命令。

详细语义见 Case 的 Related Cases。

下一步

• Skills — 让 Harness Agent 使用 ASP CLI 提供的能力。
• Setup — 在 Agent 环境中检查 CLI 登录和基础配置。
• 个人中心 — 创建用于 CLI 登录的个人 API Key。