$git clone https://github.com/derisk-ai/OpenDeriskOpenDeRisk is an AI-Native Risk Intelligence System designed as your application system's intelligent manager, providing 7×24 hour comprehensive and in-depth protection.
| 1 | ### OpenDeRisk |
| 2 | |
| 3 | OpenDeRisk is an AI-Native Risk Intelligence System designed as your application system's intelligent manager, providing 7×24 hour comprehensive and in-depth protection. |
| 4 | |
| 5 | <div align="center"> |
| 6 | <p> |
| 7 | <a href="https://github.com/derisk-ai/OpenDerisk"> |
| 8 | <img alt="stars" src="https://img.shields.io/github/stars/derisk-ai/OpenDerisk?style=social" /> |
| 9 | </a> |
| 10 | <a href="https://github.com/derisk-ai/OpenDerisk"> |
| 11 | <img alt="forks" src="https://img.shields.io/github/forks/derisk-ai/OpenDerisk?style=social" /> |
| 12 | </a> |
| 13 | <a href="https://opensource.org/licenses/MIT"> |
| 14 | <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" /> |
| 15 | </a> |
| 16 | <a href="https://github.com/derisk-ai/OpenDerisk/releases"> |
| 17 | <img alt="Release Notes" src="https://img.shields.io/github/release/derisk-ai/OpenDerisk" /> |
| 18 | </a> |
| 19 | <a href="https://github.com/derisk-ai/OpenDerisk/issues"> |
| 20 | <img alt="Open Issues" src="https://img.shields.io/github/issues-raw/derisk-ai/OpenDerisk" /> |
| 21 | </a> |
| 22 | <a href="https://codespaces.new/derisk-ai/OpenDerisk"> |
| 23 | <img alt="Open in GitHub Codespaces" src="https://github.com/codespaces/badge.svg" /> |
| 24 | </a> |
| 25 | <a href="https://discord.com/invite/bgWkskhe"> |
| 26 | <img alt="Discord" src="https://img.shields.io/discord/1335244307281457152?color=7289DA&label=Discord&logo=discord&logoColor=white" /> |
| 27 | </a> |
| 28 | </p> |
| 29 | |
| 30 | [**English**](README.md) | [**简体中文**](README.zh.md) | [**日本語**](README.ja.md) | [**Video Tutorial**](https://www.youtube.com/watch?v=1qDIu-Jwdf0) |
| 31 | </div> |
| 32 | |
| 33 | ### Features |
| 34 | 1. **DeepResearch RCA:** Quickly locate root causes through in-depth analysis of logs, traces, and code. |
| 35 | 2. **Visualized Evidence Chain:** Fully visualize diagnostic processes and evidence chains for clear, accurate judgment. |
| 36 | 3. **Multi-Agent Collaboration:** SRE-Agent, Code-Agent, ReportAgent, Vis-Agent, and Data-Agent working in coordination. |
| 37 | 4. **Open-Source Architecture:** Built with a completely open architecture, enabling framework and code reuse in open-source projects. |
| 38 | |
| 39 | <p align="left"> |
| 40 | <img src="./assets/features.jpg" width="100%" /> |
| 41 | </p> |
| 42 | |
| 43 | ### Architecture |
| 44 | <p align="left"> |
| 45 | <img src="./assets/arch_en.jpg" width="100%" /> |
| 46 | </p> |
| 47 | |
| 48 | #### Introduction |
| 49 | The system employs a multi-agent architecture. Currently, the code primarily implements the highlighted components. Alert awareness is based on Microsoft's open-source [OpenRCA dataset](https://github.com/microsoft/OpenRCA). The decompressed dataset is approximately 26GB. On this dataset, we achieve root cause analysis through multi-agent collaboration, with Code-Agent dynamically writing code for final analysis. |
| 50 | |
| 51 | #### Technical Implementation |
| 52 | **Data Layer:** Pull the large-scale OpenRCA dataset (20GB) from GitHub, decompress locally, and process for analysis. |
| 53 | |
| 54 | **Logic Layer:** Multi-agent architecture with SRE-Agent, Code-Agent, ReportAgent, Vis-Agent, and Data-Agent collaborating for deep DeepResearch RCA (Root Cause Analysis). |
| 55 | |
| 56 | **Visualization Layer:** Use the Vis protocol to dynamically render the entire processing flow and evidence chain, as well as the multi-role collaboration and switching process. |
| 57 | |
| 58 | Digital Employees (Agents) in OpenDeRisk |
| 59 | <p align="left"> |
| 60 | <img src="./assets/ai-agent.png" width="100%" /> |
| 61 | </p> |
| 62 | |
| 63 | ### Install (recommended) |
| 64 | |
| 65 | #### Install via curl |
| 66 | |
| 67 | ```shell |
| 68 | # Download and install latest version |
| 69 | curl -fsSL https://raw.githubusercontent.com/derisk-ai/OpenDerisk/main/install.sh | bash |
| 70 | ``` |
| 71 | #### Configuration File |
| 72 | After installation, the default configuration file is automatically initialized at: |
| 73 | `~/.openderisk/configs/derisk-proxy-aliyun.toml` |
| 74 | |
| 75 | Edit this file and set your API keys: |
| 76 | ```shell |
| 77 | vi ~/.openderisk/configs/derisk-proxy-aliyun.toml |
| 78 | ``` |
| 79 | |
| 80 | #### Start |
| 81 | ``` |
| 82 | openderisk-server |
| 83 | ``` |
| 84 | |
| 85 | ### From source(development) |
| 86 | |
| 87 | #### Install uv (required) |
| 88 | |
| 89 | **macOS/Linux:** |
| 90 | ```shell |
| 91 | curl -LsSf https://astral.sh/uv/install.sh | sh |
| 92 | ``` |
| 93 | |
| 94 | **Windows:** |
| 95 | ```shell |
| 96 | powershell -c "irm https://astral.sh/uv/install.ps1 | iex" |
| 97 | ``` |
| 98 | |
| 99 | #### |