pentestagent

环境要求

• Python 3.10+
• OpenAI、Anthropic 或其他 LiteLLM 支持的 provider 的 API key
• Windows 需 PowerShell，Linux/macOS 需 Bash 环境
• 使用 Docker 方式运行工具时需安装 Docker 与 docker compose

安装与启动步骤

1. 1克隆项目仓库

   把仓库拉到本地并进入项目目录，后续所有命令都在该目录下执行。

   git clone https://github.com/GH05TCREW/pentestagent.git
   cd pentestagent

   复制

2. 2运行安装脚本

   脚本会自动创建 venv 并安装依赖。Windows 用 .\scripts\setup.ps1，Linux/macOS 用下方命令。

   ./scripts/setup.sh

   复制

3. 3或手动安装依赖

   不使用脚本时，手动创建虚拟环境、激活后以可编辑模式安装全部依赖。Windows 激活命令为 .\venv\Scripts\Activate.ps1。

   python -m venv venv
   source venv/bin/activate
   pip install -e ".[all]"

   复制

4. 4安装浏览器依赖

   browser 工具需要 Playwright 的 Chromium，必须单独执行一次安装，否则浏览器相关功能不可用。

   playwright install chromium

   复制

5. 5配置 API 密钥

   在项目根目录新建 .env 文件，写入所选厂商的 API Key 和要使用的模型名，二者缺一不可。

6. 6启动 TUI

   直接运行进入交互界面；也可用 -t 指定目标 IP 启动，或在 Docker 容器内运行工具（tui --docker）。

   pentestagent

   复制

7. 7Docker 方式运行

   需要隔离环境或想直接用镜像内预装的渗透工具时，改用 docker compose 运行，项目提供 compose 配置。

   docker compose run --rm pentestagent

   复制

关键配置

如何确认成功

执行 pentestagent 后成功进入 TUI 交互界面，即表示安装与配置生效。

常见问题

注意事项

• 仅在你拥有明确授权的目标上使用，未经授权的渗透测试属于违法行为。
• 使用前必须提供 API key，否则无法调用大模型进行任务规划与推理。
• PENTESTAGENT_MODEL 需填写所选厂商真实存在的模型名，任意 LiteLLM 支持的模型都可。
• Docker 模式与本地模式的目标不同：本地运行的是 Agent 本身，Docker 用于隔离运行具体测试工具。