CyberStrikeAI/docs/README.md

CyberStrikeAI Documentation

中文 | English

CyberStrikeAI documentation is organized by user journey. Start with deployment, then move to the topic that matches your task.

中文文档

按目标开始

• 快速体验：部署指南 → 配置参考 → 排错指南
• 生产部署：配置画像 → 安全加固 → 运维 Runbooks → 审计与监控
• 接入与自动化：API 参考 → API Recipes → MCP 联邦
• 参与开发：开发者指南 → 测试指南 → 贡献规范

核心概念与编排

• 架构说明
• 安全模型
• Agent 与角色
• Skills 指南
• Eino 多代理
• 工作流
• 人机协同最佳实践

功能指南

• 知识库
• RBAC 权限管理
• 机器人接入
• 视觉分析
• WebShell 管理
• C2 使用说明

开发与发布

• 开发者指南
• 插件开发
• 前端国际化
• 测试指南
• 贡献规范
• 发布流程

English Documentation

Choose a path

• Try locally: Deployment → Configuration → Troubleshooting
• Run in production: Configuration Profiles → Security Hardening → Runbooks → Audit and Monitoring
• Integrate and automate: API Reference → API Recipes → MCP Federation
• Contribute code: Developer Guide → Testing → Contributing

Concepts and orchestration

• Architecture
• Security Model
• Agents and Roles
• Skills
• Eino Multi-Agent
• Workflows
• HITL Best Practices

Feature guides

• Knowledge Base
• RBAC Administration
• Robot / Chatbot
• Vision Analysis
• WebShell Management
• C2 Guide

Development and release

• Developer Guide
• Plugin Development
• Frontend i18n
• Testing
• Contributing
• Release Process

Documentation conventions

• Commands assume the repository root unless stated otherwise.
• Examples use placeholders; never commit real credentials or target systems without explicit authorization.
• Runtime behavior and configuration defaults are authoritative in config.example.yaml and the source code. If a document differs, report it as documentation drift.