CyberStrikeAI README

The project's README from github.com/AIPentest/CyberStrikeAI. As one markdown file: README.md.

CyberStrikeAI Logo

CyberStrikeAI

中文 | English

The system of action for AI-native cybersecurity—where intent becomes governed execution, evidence becomes operational memory, and every operation improves the next.

CyberStrikeAI connects planning, execution, human oversight, evidence, and replay in one auditable workspace. Built in Go, it combines Eino-powered agents, MCP-native tools, RAG knowledge, visual workflows, and attack-chain modeling and analysis for authorized security operations.

Start here: Quick start · Documentation · Security hardening

[!IMPORTANT] Use CyberStrikeAI only on systems you own or are explicitly authorized to test. For shared or production environments, review the security model and hardening guide before enabling high-risk tools, WebShell, or C2 capabilities.

Interface & Integration Preview

System Dashboard Overview

Light Mode
System Dashboard (Light)
Dark Mode
System Dashboard (Dark)

The dashboard provides a comprehensive overview of system runtime status, security vulnerabilities, tool usage, and knowledge base, helping users quickly understand the platform's core features and current state.

More interface screenshots

Core Features Overview

Web Console
Web Console
Task Management
Task Management
Vulnerability Management
Vulnerability Management
WebShell Management
WebShell Management
MCP Management
MCP management
Knowledge Base
Knowledge Base
Skills Management
Skills Management
Agent Management
Agent Management
Role Management
Role Management
System Settings
System settings
MCP stdio Mode
MCP stdio mode
Burp Suite Plugin
Burp Suite plugin

Highlights

Agents and orchestration

Tools and knowledge

Governance and audit

Security operations

Authorized security operations

WebShell, C2, and other high-risk capabilities are for systems you own or are explicitly authorized to test. See the security model and hardening guide.

Plugins

CyberStrikeAI includes optional integrations under plugins/.

Tool Overview

CyberStrikeAI ships with 100+ curated tools covering the whole kill chain:

View the complete tool categories
  • Network Scanners – nmap, masscan, rustscan, arp-scan, nbtscan
  • Web & App Scanners – sqlmap, nikto, dirb, gobuster, feroxbuster, ffuf, httpx
  • Vulnerability Scanners – nuclei, wpscan, wafw00f, dalfox, xsser
  • Subdomain Enumeration – subfinder, amass, findomain, dnsenum, fierce
  • Network Space Search Engines – fofa_search, zoomeye_search, quake_search, shodan_search
  • API Security – graphql-scanner, arjun, api-fuzzer, api-schema-analyzer
  • Container Security – trivy, clair, docker-bench-security, kube-bench, kube-hunter
  • Cloud Security – prowler, scout-suite, cloudmapper, pacu, terrascan, checkov
  • Binary Analysis – gdb, radare2, ghidra, objdump, strings, binwalk
  • Exploitation – metasploit, msfvenom, pwntools, ropper, ropgadget
  • Password Cracking – hashcat, john, hashpump
  • Forensics – volatility, volatility3, foremost, steghide, exiftool
  • Post-Exploitation – linpeas, winpeas, mimikatz, bloodhound, impacket, responder
  • CTF Utilities – stegsolve, zsteg, hash-identifier, fcrackzip, pdfcrack, cyberchef
  • System Helpers – exec, create-file, delete-file, list-files, modify-file

See tools/README_EN.md for tool definitions, customization, and usage notes.

Basic Usage

Quick Start (One-Command Deployment)

Prerequisites:

One-Command Deployment:

git clone https://github.com/Ed1s0nZ/CyberStrikeAI.git
cd CyberStrikeAI
chmod +x run.sh && ./run.sh

The run.sh script will automatically:

Verify the startup:

  1. Confirm the terminal displays ● ONLINE followed by the actual Web UI URL.
  2. Open that URL; the default HTTPS mode uses a local self-signed certificate, so accept the browser warning once.
  3. On a new installation, store the one-time admin password shown under ADMIN SETUP REQUIRED, sign in, and change it immediately.

Networking defaults: run.sh starts the server with --https and the repo config.yaml (local self-signed TLS; better for many concurrent streams). Use ./run.sh --http for plain HTTP. In production, set server.tls_cert_path / server.tls_key_path in config.yaml (see comments there). For manual runs, add --https or CYBERSTRIKE_HTTPS=1; if -config is wrong, the binary prints a short usage hint on stderr.

First-Time Configuration:

  1. Configure AI channels (required before first use)

    • After launch, open https://127.0.0.1:8080/ (or https://localhost:8080/; replace 8080 with server.port in config.yaml) and accept the self-signed certificate warning once. If you used ./run.sh --http, use http:// instead.
    • Go to System Settings → Basic Settings → AI Channel Configuration, add or edit a channel, then fill in provider, Base URL, API key, model, and token limits. Click Save changes. The left channel list supports setting a default, copy, delete, and bulk probe.
      ai:
        default_channel: openai-main
        channels:
          openai-main:
            name: OpenAI Main
            provider: openai_compatible
            api_key: "${OPENAI_API_KEY}"
            base_url: "https://api.openai.com/v1"  # or https://api.deepseek.com/v1
            model: "gpt-4o"  # or deepseek-chat, qwen3-max, etc.
            max_total_tokens: 120000
            max_completion_tokens: 16384
      
    • Or edit config.yaml directly before launching. ai.default_channel is used for new conversations and tasks that do not explicitly select a channel; the chat page can also select any saved channel per session.
  2. Login - On first startup the console prints an auto-generated initial admin password; create accounts from Platform permissions → User management

  3. Install security tools (optional) - Install tools from tools/ as needed; missing tools are skipped or substituted at runtime. Common examples:

    macOS (Homebrew):

    brew install nmap masscan sqlmap nikto gobuster ffuf hydra hashcat nuclei subfinder
    

    Linux (Kali / Debian / Ubuntu):

    sudo apt update
    sudo apt install -y nmap masscan sqlmap nikto gobuster hydra hashcat john binwalk
    # On some distros, install ffuf/nuclei/subfinder via go install or upstream docs
    

    See the tools/ directory for the full list; refer to each tool's official docs for install details.

Alternative Launch Methods:

# Direct Go run (set up env yourself); add --https to match run.sh defaults
go run cmd/server/main.go --https

# Manual build
go build -o cyberstrike-ai cmd/server/main.go
./cyberstrike-ai --https

If server logs show client sent an HTTP request to an HTTPS server, a client is still using http:// on a TLS-only port—switch the URL to https://.

Note: The Python virtual environment (venv/) is automatically created and managed by run.sh. Tools that require Python (like api-fuzzer, http-framework-test, etc.) will automatically use this environment.

Upgrade and Compatibility

CyberStrikeAI one-click upgrade:

  1. (First time) enable the script: chmod +x upgrade.sh
  2. Upgrade with: ./upgrade.sh (optional flags: --tag vX.Y.Z, --no-venv, --yes). Local tools/, roles/, and skills/ are always preserved.
  3. The script will back up your config.yaml and data/, upgrade the code from GitHub Release, update config.yaml's version, then restart the server.

Recommended one-liner: chmod +x upgrade.sh && ./upgrade.sh --yes

If something goes wrong, you can restore from .upgrade-backup/ (or manually copy /data and config.yaml back) and run ./run.sh again.

Requirements / tips:

⚠️ Before upgrading: review the target release notes for configuration, database, and API changes. Backups are required even for patch upgrades; a version number alone is not a compatibility guarantee.

Configuration

Use config.example.yaml as the authoritative configuration template and copy only the values required for your environment. At minimum, configure the server and one AI channel:

server:
  host: "127.0.0.1"
  port: 8080
ai:
  default_channel: openai-main
  channels:
    openai-main:
      provider: openai_compatible
      api_key: "${OPENAI_API_KEY}"
      base_url: "https://api.openai.com/v1"
      model: "your-model"

openai is a backward-compatible runtime field; maintain new model settings in ai.channels. Do not commit real credentials. Review the configuration reference, recommended profiles, and security hardening guide before exposing the service beyond localhost.

Project Layout

CyberStrikeAI/
├── cmd/                 # Server, MCP stdio entrypoints, tooling
├── internal/            # Agent, MCP core, handlers, C2 (`internal/c2`), security executor
├── web/                 # Static SPA + templates
├── tools/               # YAML tool recipes (100+ examples provided)
├── roles/               # Role configurations (12+ predefined security testing roles)
├── skills/              # Agent Skills dirs (SKILL.md + optional files; demo: cyberstrike-eino-demo)
├── agents/              # Multi-agent Markdown (orchestrator.md + sub-agent *.md)
├── docs/                # Topic docs (deployment, config, security, API, knowledge base, C2, WebShell, etc.)
├── images/              # Docs screenshots & diagrams
├── scripts/             # Repository maintenance checks, including documentation validation
├── config.yaml          # Runtime configuration
├── run.sh               # Convenience launcher
└── README*.md

Basic Usage Examples

Scan open ports on 192.168.1.1
Perform a comprehensive port scan on 192.168.1.1 focusing on 80,443,22
Check if https://example.com/page?id=1 is vulnerable to SQL injection
Scan https://example.com for hidden directories and outdated software
Enumerate subdomains for example.com, then run nuclei against the results

Advanced Playbooks

Load the recon-engagement template, run amass/subfinder, then brute-force dirs on every live host.
Use external Burp-based MCP server for authenticated traffic replay, then pass findings back for graphing.
Compress the 5 MB nuclei report, summarize critical CVEs, and attach the artifact to the conversation.
Build an attack chain for the latest engagement and export the node list with severity >= high.

CyberStrikeAI has joined 404Starlink

TCH Top-Ranked Intelligent Pentest Project

TCH Top-Ranked Intelligent Pentest Project

Community and Support

WeChat group CyberStrikeAI WeChat group QR code
Sponsorship via WeChat Pay or Alipay
WeChat Pay and Alipay sponsorship QR codes

License

CyberStrikeAI is licensed under the Apache License 2.0.
See the LICENSE file for details.


⚠️ Disclaimer

This tool is for educational and authorized testing purposes only!

CyberStrikeAI is a professional security testing platform designed to assist security researchers, penetration testers, and IT professionals in conducting security assessments and vulnerability research with explicit authorization.

By using this tool, you agree to:

CyberStrikeAI (AIPentest/CyberStrikeAI)

Searching Database…

这是什么?CyberStrikeAI 是一个 AI 原生的网络安全平台,它能把自然语言指令转化为受管控、可审计的安全运营工作。它借助智能体、100 多种安全工具、MCP 集成以及攻击链追踪功能,用于经授权的渗透测试。
这是命令行工具还是完整平台?它是一个可自行部署的服务器应用,带有 Web 控制台(仪表盘、任务管理、知识库),使用 Go 构建,不是代码库,也不是简单脚本。
我该如何让它运行起来?运行随附的 run.sh 脚本即可一键部署:它会检查你的 Go/Python 环境,创建 Python 虚拟环境,安装依赖,构建项目,并以本地自签名 HTTPS 证书启动服务器。
运行前是否需要先安装 Go 和 Python?需要,Go 1.25+ 和 Python 3.10+ 是必备的前置条件;其余内容(虚拟环境、pip 安装、Go 模块下载)由 run.sh 自动处理。
安装时有哪些需要留意的坑?默认启动方式使用本地自签名 TLS 证书,因此你需要在浏览器中忽略一次安全警告。此外,在智能体真正能工作之前,你必须配置 AI 通道(服务商、API 密钥、模型)。
这个工具面向哪些人?对任意目标运行它是否合法?它面向安全研究人员、渗透测试人员和 IT 专业人士,严格限定于你拥有或已获明确授权测试的系统。WebShell 和 C2 等高风险工具必须以此授权为前提。
它支持哪些平台?CyberStrikeAI 以服务器形式运行于 macOS 和 Linux(Kali/Debian/Ubuntu)上,添加安全工具时两者均提供安装说明;文档中未提及 Windows。
我的数据和证据存储在哪里?所有内容都保存在你自己的部署环境中:操作记录、审计日志和证据都以 SQLite 形式保存在本地,不会发送给第三方服务。
有哪些多智能体编排模式?基于 Eino 构建,支持单智能体执行,以及 Deep、Plan-Execute 和 Supervisor 多智能体模式,并可将这些模式组合成可复用的图工作流,支持审批和条件判断。
它能与 Burp Suite 集成或捕获浏览器流量吗?可以,它提供可选插件:一个 Burp Suite 扩展,以及一个 Chrome/Edge 浏览器扩展。后者可捕获 DevTools 网络流量并将其提供给 CyberStrikeAI,用于 AI 辅助测试。
内置了哪些安全工具?内置 100 多个经过筛选、以 YAML 定义的工具,覆盖完整攻击链,包括 nmap、sqlmap、nuclei、subfinder、metasploit、hashcat、volatility、mimikatz、bloodhound 等,并支持自定义扩展。
是否包含命令与控制(C2)功能?包含。内置的 C2 模块提供监听器、加密信标、会话、任务队列和载荷辅助功能,严格限定用于经授权的测试项目。
Creator
AIPentest
Size
65.9 MB
Stars
7.9K
Age
11mo
Commits · 90 Days