osmedeus

环境要求

• Linux/macOS 等可执行 Bash 脚本的环境
• 已安装 curl（安装脚本通过 curl 管道执行）
• 如需容器方式运行，需预先安装 Docker
• 使用 agent 功能时需要有可用的 ACP 智能体（如 codex）

安装与启动步骤

1. 1一键安装

   官方提供的安装脚本，通过 curl 下载并直接交给 bash 执行，安装完成后 osmedeus 命令即可用。

   curl -sSL http://www.osmedeus.org/install.sh | bash

   复制

2. 2安装预设仓库

   从预设仓库安装 base 与 workflow 资源；加 --keep-setting 可保留已有的 osm-settings.yaml 配置。

   osmedeus install base --preset
   osmedeus install workflow --preset

   复制

3. 3运行模块工作流

   使用 -m 指定模块（如 recon 侦察模块），-t 指定目标域名，执行单模块任务。

   osmedeus run -m recon -t example.com

   复制

4. 4运行完整流程

   使用 -f 指定 flow 流程（如 general），把多个模块串起来一次性执行完整评估。

   osmedeus run -f general -t example.com

   复制

5. 5预演模式

   加上 --dry-run 只预览将要执行的流程和步骤，不会真正发起扫描，适合先确认范围。

   osmedeus run -f general -t example.com --dry-run

   复制

6. 6查询结果

   query 子命令可查漏洞、运行记录和步骤；按 severity、status、run 等条件过滤。

   osmedeus query vulns --severity high --workspace example.com
   osmedeus query runs --status running

   复制

7. 7交互式智能体

   agent 子命令以 ACP 智能体方式交互执行任务，可用 --agent 指定具体智能体，--list 查看可用项。

   osmedeus agent "analyze this codebase"
   osmedeus agent --agent codex "explain main.go"
   osmedeus agent --list

   复制

8. 8Docker 方式运行

   使用官方镜像 j3ssie/osmedeus:latest，把宿主机目录挂载到 /root/workspaces-osmedeus 保存结果。

   docker run --rm -v $(pwd)/output:/root/workspaces-osmedeus j3ssie/osmedeus:latest run -f general -t example.com

   复制

关键配置

如何确认成功

执行 osmedeus --usage-example，能列出全部用法示例即表示安装成功、命令可用。

常见问题

注意事项

• osmedeus 是安全扫描编排工具，请仅对已获得授权的目标使用。
• Docker 方式需将宿主机目录挂载到容器内 /root/workspaces-osmedeus 才能取回扫描结果。
• 使用 agent 功能前需先准备好对应 ACP 智能体，可用 osmedeus agent --list 查看可用项。
• README 未说明系统依赖与最低版本，安装前建议先查阅官网文档 docs.osmedeus.org。