Skip to content

quick_start.md

Latest commit

 

History

History
85 lines (55 loc) · 2.09 KB

quick_start.md

File metadata and controls

85 lines (55 loc) · 2.09 KB

Cerberus 快速开始指南

欢迎使用 Cerberus！本指南将帮助你在 5 分钟内上手 Cerberus。

🎯 选择你的方式

根据你的需求，选择最适合的部署方式：

你是... 推荐方式 时间
普通用户，想快速试用 方式 2: 独立二进制 ⏱ 3 分钟
熟悉容器技术 方式 1: 容器化部署 ⏱ 2 分钟
开发者，想贡献代码 详细部署文档 ⏱ 10 分钟

方式 1: 容器化部署

前提条件: 安装 Podman 或 Docker

# 克隆仓库
git clone https://github.com/code-symph/Cerberus.git
cd Cerberus

# 构建并运行（一条命令）
./scripts/build-container.sh && podman run --rm -it cerberus:latest

✅ 完成！ Cerberus 现在正在容器中运行。

方式 2: 独立二进制（推荐新手）

前提条件: 仅在首次构建时需要 Python 3.13+、CMake、C++ 编译器

# 克隆仓库
git clone https://github.com/code-symph/Cerberus.git
cd Cerberus

# 一键构建
./scripts/build-binary.sh

# 运行
./dist/cerberus

✅ 完成！ 以后可以直接运行 ./dist/cerberus，无需 Python。

🎮 基本使用

成功运行后，你会看到：

--- Cerberus Penetration Testing Tool ---
Connection to C++ core established: Hello, Operator from C++!

Tool is now ready for commands...

下一步

🔧 遇到问题？

  • 容器构建失败：确保已安装 Podman/Docker
  • 二进制构建失败：检查是否安装了 CMake 和 C++ 编译器
  • 其他问题：查看故障排除

📞 获取帮助