CyberStrikeAI/docs/en-US/README.md

English Docs

• Deployment Guide: deployment modes, HTTPS, reverse proxy, systemd, backup, upgrade, and acceptance checks.
• Runbooks: operational steps for production setup, external MCP, KB, Web testing, C2 cleanup, and tool debugging.
• Configuration Profiles: recommended profiles for dev, internal team, knowledge-only, production, C2, and MCP automation.
• Security Hardening: pre-launch baseline, reverse proxy, HITL allowlist, file permissions, and periodic review.
• API Recipes: examples for login, Agent, streaming, multi-agent, uploads, vulnerabilities, KB, MCP, and audit export.
• Contributing Guide: checklists for APIs, config, tools, frontend, DB, high-risk features, and docs.
• Configuration Reference: config.yaml fields, hot-apply boundaries, recommended values, and source anchors.
• Security Model: trust boundaries, HITL, tool execution, C2/WebShell, and data safety.
• Architecture: request flow, module relationships, complexity hotspots, and design trade-offs.
• API Reference: authentication, OpenAPI, SSE, stability tiers, and common endpoints.
• Troubleshooting: diagnostic order, minimal commands, common misdiagnoses, and issue template.
• Audit and Monitoring: platform audit, tool monitoring, HITL logs, and retention.
• Knowledge Base: indexing pipeline, retrieval tuning, log analysis, and content writing.
• C2 Guide: lifecycle, task classification, event review, and safety guidance.
• WebShell Management: operation tiers, naming, AI guardrails, and troubleshooting.
• MCP Federation: built-in MCP, external MCP, lifecycle, and tool naming.
• Agent and Role Guide: roles, sub-agents, Skills, orchestration modes, and tool visibility.
• Skills Guide: Skill structure, progressive disclosure, anti-patterns, and local-tool risk.
• Plugin Development: API plugins, MCP plugins, resource-pack plugins, and security boundaries.
• Release Process: release risk, config compatibility, DB migrations, and acceptance checks.
• Testing Guide: test layers, regression focus, test data, and failure cases.
• Graph Orchestration Guide
• HITL Best Practices
• Robot / Chatbot Guide
• Vision Analysis
• Frontend i18n
• Eino Multi-Agent Notes