Repository: iflytek/astron-agent

Stars: 9411

CLAUDE.md Copy Chapter

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

项目概述 Copy Chapter

Astron Agent 是一个企业级 Agentic Workflow 开发平台,采用微服务架构,整合了 AI 工作流编排、模型管理、AI 工具、RPA 自动化和团队协作功能。

技术栈概览 Copy Section

- 前端: TypeScript + React 18 + Vite + Ant Design (位于 console/frontend/)
- 控制台后端: Java 21 + Spring Boot 3.5.4 (位于 console/backend/)
- 核心微服务: Python 3.11+ + FastAPI (位于 core/ 目录)
- 租户服务: Go 1.23 + Gin (位于 core/tenant/)
- 基础设施: MySQL, Redis, Kafka, MinIO

项目架构 Copy Chapter

目录结构 Copy Section

astron-agent/
├── console/                    # 控制台模块
│   ├── frontend/              # React 前端 (TypeScript)
│   └── backend/               # Spring Boot 后端 (Java)
│       ├── hub/               # 主 API 服务
│       ├── toolkit/           # 工具模块
│       └── commons/           # 公共模块
├── core/                      # 核心微服务
│   ├── agent/                 # Agent 服务 (Python FastAPI)
│   ├── workflow/              # 工作流服务 (Python FastAPI)
│   ├── knowledge/             # 知识库服务 (Python FastAPI)
│   ├── memory/                # 内存数据库服务 (Python)
│   ├── tenant/                # 租户服务 (Go Gin)
│   ├── common/                # 公共模块 (Python)
│   └── plugin/                # 插件系统
│       ├── aitools/           # AI 工具插件
│       ├── rpa/               # RPA 插件
│       └── link/              # 链接插件
├── docker/                    # Docker 配置
├── docs/                      # 文档
├── helm/                      # Kubernetes Helm Charts
└── makefiles/                 # Makefile 工具链

核心架构模式 Copy Section

#### 1. 微服务通信

- Frontend → Backend: HTTP/REST + SSE (服务端推送)
- Backend → Core Services: HTTP/REST API
- Core Services ↔ Core Services: Kafka 事件驱动 (异步)
- 数据持久化: MySQL (关系数据) + Redis (缓存/会话)
- 文件存储: MinIO (对象存储)

#### 2. Kafka 事件主题

- workflow-events: 工作流事件
- knowledge-events: 知识库事件
- agent-events: Agent 事件

#### 3. Python 服务架构 (DDD)

所有 Python 微服务遵循领域驱动设计 (DDD):

service/
├── api/                       # API 层 (FastAPI 路由)
├── service/                   # 服务层 (业务逻辑)
├── domain/                    # 领域层 (领域模型)
├── repository/                # 仓储层 (数据访问)
└── main.py                    # 服务入口

#### 4. 公共模块 (core/common)

为所有 Python 服务提供统一的基础设施:

- 认证和审计系统 (MetrologyAuth)
- 可观测性支持 (OpenTelemetry)
- 数据库、缓存、消息队列连接管理
- 统一日志系统
- OSS 对象存储集成

部署 Copy Chapter

Docker Compose 部署 (推荐快速开始) Copy Section

cd docker/astronAgent
cp .env.example .env
vim .env                        # 配置环境变量
启动所有服务 (包括 Casdoor 认证)

docker compose -f docker-compose-with-auth.yaml up -d
访问地址

- 前端: http://localhost/

- Casdoor 管理: http://localhost:8000 (admin/123)

重要注意事项 Copy Chapter

开发约定 Copy Section

1. 禁止直接推送到 main/develop 分支 - 必须通过分支开发 + PR 流程

模块间依赖 Copy Section

- Common Module 被所有 Python 服务依赖,修改时需谨慎
- Agent Service 被 Workflow 服务调用
- Knowledge Service 为 Agent 和 Workflow 提供 RAG 能力
- Tenant Service 为所有服务提供租户上下文

相关文档 Copy Chapter

- 项目模块说明 - 详细架构说明
- 部署指南 - 完整部署步骤
- 前端开发指南 - 前端特定指南

README.md Copy Chapter


<div align="center">


English | 简体中文

</div>

🔭 What is Astron Agent Copy Chapter

Why Choose Astron Agent? Copy Section

Key Features Copy Section

📰 News Copy Chapter

🔄 Ongoing Copy Section

📅 Past Copy Section

- Astron Hackathon @ 2025 iFLYTEK Global 1024 Developer Festival 🎤 <a href="https://github.com/mklong"><img src="https://github.com/mklong.png" width="20" align="center" /> @mklong</a>
- Astron Agent Zhengzhou Meetup 🎤 <a href="https://github.com/lyj715824"><img src="https://github.com/lyj715824.png" width="20" align="center" /> @lyj715824</a> <a href="https://github.com/wowo-zZ"><img src="https://github.com/wowo-zZ.png" width="20" align="center" /> @wowo-zZ</a>
- Astron on Campus @ Zhejiang University of Finance and Economics 🎤 <a href="https://github.com/lyj715824"><img src="https://github.com/lyj715824.png" width="20" align="center" /> @lyj715824</a>
- Astron Agent & RPA · Qingdao Meetup Brings Agentic AI! 🎤 <a href="https://github.com/vsxd"><img src="https://github.com/vsxd.png" width="20" align="center" /> @vsxd</a> <a href="https://github.com/doctorbruce"><img src="https://github.com/doctorbruce.png" width="20" align="center" /> @doctorbruce</a> <a href="https://github.com/MaxwellJean"><img src="https://github.com/MaxwellJean.png" width="20" align="center" /> @MaxwellJean</a>
- Astron Training Camp · Cohort #1 🎤 <a href="https://github.com/lyj715824"><img src="https://github.com/lyj715824.png" width="20" align="center" /> @lyj715824</a> <a href="https://github.com/Thomas1024-Astron"><img src="https://github.com/Thomas1024-Astron.png" width="20" align="center" /> @Thomas1024-Astron</a> <a href="https://github.com/abelzha"><img src="https://github.com/abelzha.png" width="20" align="center" /> @abelzha</a>
- Astron Talk @ Chongqing Mini Tech Fest 🎤 <a href="https://github.com/lyj715824"><img src="https://github.com/lyj715824.png" width="20" align="center" /> @lyj715824</a>
- Astron Agent @ MWC Barcelona 2026
- Astron Agent & RPA · Hefei Meetup 🎤 <a href="https://github.com/lyj715824"><img src="https://github.com/lyj715824.png" width="20" align="center" /> @lyj715824</a> <a href="https://github.com/doctorbruce"><img src="https://github.com/doctorbruce.png" width="20" align="center" /> @doctorbruce</a>
- Astron Industrial Intelligence Hackathon 🎤 <a href="https://github.com/lyj715824"><img src="https://github.com/lyj715824.png" width="20" align="center" /> @lyj715824</a> <a href="https://github.com/horizon220222"><img src="https://github.com/horizon220222.png" width="20" align="center" /> @horizon220222</a>

🚀 Quick Start Copy Chapter

We offer two deployment methods to meet different scenarios:

Option 1: Docker Compose (Recommended for Quick Start) Copy Section

Clone the repository

git clone https://github.com/iflytek/astron-agent.git
Navigate to the Docker deployment directory

cd docker/astronAgent
Copy environment configuration

cp .env.example .env
Configure environment variables

vim .env

For environment variable configuration, please refer to the documentation:DEPLOYMENT_GUIDE_WITH_AUTH.md

Start all services (including Casdoor)

docker compose -f docker-compose-with-auth.yaml up -d

#### 📊 Service Access Addresses

After startup, you can access the services at the following addresses:

Authentication Service
- Casdoor Admin Interface: http://localhost:8000

AstronAgent
- Application Frontend (nginx proxy): http://localhost/

Note
- Default Casdoor login credentials: username: admin, password: 123

Option 2: Helm (For Kubernetes Environments) Copy Section

🚧 Note: Helm charts are currently under development. Stay tuned for updates!

Coming soon

helm repo add astron-agent https://iflytek.github.io/astron-agent

helm install astron-agent astron-agent/astron-agent

---

📖 For complete deployment instructions and configuration details, see Deployment Guide

📖 Using Astron Cloud Copy Chapter

Try Astron：Astron Cloud provides a ready-to-use environment for creating and managing Agents. Get quick access at https://agent.xfyun.cn.

Using Guide：For detailed usage instructions, please refer to Quick Start Guide.

📚 Documentation Copy Chapter

- 🚀 Deployment Guide
- 🔧 Configuration
- 🚀 Quick Start
- 📘 Development Guide
- 📖 Tutorial
- 💡 Best Practices
- 📱 Use Cases
- ❓ FAQ
- 🌐 Open Source Workflows

🤝 Contributing Copy Chapter

We welcome contributions of all kinds! Please see our Contributing Guide

🌟 Star History Copy Chapter

<div align="center">
<img src="https://api.star-history.com/svg?repos=iflytek/astron-agent&type=Date" alt="Star History Chart" width="600">
</div>

📞 Support Copy Chapter

- 💬 Community Discussion: GitHub Discussions
- 🐛 Bug Reports: Issues
- 👥 WeChat Work Group:

<div align="center">
<img src="./docs/imgs/WeCom_Group.png" alt="WeChat Work Group" width="300">
</div>

📄 Open Source License Copy Chapter

This project is licensed under the Apache 2.0 License, allowing free use, modification, distribution, and commercial use without any restrictions.