QUICKSTART.md

🚀 快速开始指南

环境准备

1. 设置LLM API密钥

选择A: 使用OpenAI模型

# 方式1: 环境变量
export LLM_PROVIDER="openai"
export OPENAI_API_KEY="your-api-key-here"

# 方式2: .env文件
cp .env.example .env
# 编辑.env文件，设置：
# LLM_PROVIDER=openai
# OPENAI_API_KEY=your-api-key-here

选择B: 使用Qwen模型（阿里云灵积）

# 方式1: 环境变量
export LLM_PROVIDER="qwen"
export QWEN_API_KEY="your-qwen-api-key-here"

# 方式2: .env文件
cp .env.example .env
# 编辑.env文件，设置：
# LLM_PROVIDER=qwen
# QWEN_API_KEY=your-qwen-api-key-here

2. 安装依赖（自动安装）

# 使用启动脚本会自动安装依赖
python run.py demo

或手动安装：

pip install -r requirements.txt

快速使用

🎯 演示模式（推荐新手）

# 查看当前模型配置
python run.py model-info

# 运行演示模式
python run.py demo

这会运行完整的演示，展示所有功能。

🔍 分析指定项目

# 分析当前目录
python run.py analyze . "分析代码质量"

# 分析指定目录
python run.py analyze /path/to/project "检查安全问题并生成报告"

💡 查看使用示例

python run.py example

🧪 运行测试

python run.py test

Agent功能概览

Agent	功能	使用场景
🧠 AI调度Agent	智能任务编排	复杂分析需求，多步骤任务
🔍 代码查询Agent	搜索代码内容	查找函数、类、特定代码模式
📁 目录扫描Agent	分析项目结构	了解项目组织、技术栈识别
🌲 AST分析Agent	静态代码分析	生成调用图、依赖关系分析
🔬 代码诊断Agent	质量检测	发现代码问题、安全漏洞
🔧 代码修复Agent	自动修复	格式化代码、修复常见问题

常用命令示例

# 全面分析
python run.py analyze ./my_project "进行全面的代码分析，包括质量检查、安全扫描和性能优化建议"

# 专注质量
python run.py analyze ./my_project "分析代码质量，找出可维护性问题"

# 安全扫描
python run.py analyze ./my_project "扫描安全漏洞和潜在风险"

# 结构分析
python run.py analyze ./my_project "分析项目结构和架构设计"

# 依赖分析
python run.py analyze ./my_project "生成依赖图和调用关系图"

输出说明

Rich格式（默认）

• 彩色表格和进度条
• 交互式树状结构
• 问题分类和统计

JSON格式

python main.py -d ./project -r "分析" -o json > report.json

故障排除

常见问题

1. ImportError: No module named 'xxx'

   pip install -r requirements.txt

2. OpenAI API错误

   # 检查API密钥设置
   echo $OPENAI_API_KEY

3. Permission denied

   # 确保有读取目标目录的权限
   chmod -R 755 /path/to/project

获取帮助

# 查看帮助
python main.py --help

# 查看详细配置
python -c "from config import settings; print(settings.dict())"

高级使用

Python API

import asyncio
from main import CodeAnalyzer

async def my_analysis():
    analyzer = CodeAnalyzer()
    result = await analyzer.analyze_code(
        user_request="分析这个Flask应用的安全性",
        target_directory="./flask_app"
    )
    return result

# 运行
result = asyncio.run(my_analysis())

自定义工作流

from core.workflow import CodeAnalysisWorkflow

workflow = CodeAnalysisWorkflow()
result = await workflow.run_analysis(
    "定制分析需求",
    "./project"
)

下一步

1. 阅读完整的 README.md
2. 查看 example.py 中的详细示例
3. 运行测试了解各个组件：python run.py test
4. 根据需要自定义Agent和工具

---

🎉 现在您已经可以开始使用代码分析Agent系统了！