rucora

用 Rust 编写的高性能、类型安全的 LLM 应用开发框架

✨ 特性

• ⚡ 极速性能 - Rust 原生，零成本抽象
• 🔒 类型安全 - 编译时错误检查，运行时更可靠
• 💰 成本监控 - 内置 Token 计数和成本管理
• 🧰 丰富工具 - 12+ 内置工具（Shell/File/HTTP/Git/Memory 等）
• 🔌 灵活集成 - 支持 10+ LLM Provider（OpenAI、Anthropic、Gemini、Ollama 等）
• 📊 可观测性 - 完整的日志、指标、追踪支持
• 🧠 Agent 架构 - 思考与执行分离，支持自定义 Agent

🚀 快速开始

1. 安装依赖

cargo add rucora

2. 设置环境变量

快速开始示例使用 OpenAiProvider，需要设置以下环境变量：

必需：

• OPENAI_API_KEY - OpenAI API 密钥

可选：

• OPENAI_BASE_URL - 自定义 API 地址（如使用 Ollama 本地模型或其他兼容服务）

在不同命令行中设置环境变量

Windows CMD:

set OPENAI_API_KEY=sk-your-api-key-here
set OPENAI_BASE_URL=https://api.openai.com/v1

Windows PowerShell:

$env:OPENAI_API_KEY = "sk-your-api-key-here"
$env:OPENAI_BASE_URL = "https://api.openai.com/v1"

Linux / macOS (bash/zsh):

export OPENAI_API_KEY="sk-your-api-key-here"
export OPENAI_BASE_URL="https://api.openai.com/v1"

提示: 以上设置仅对当前终端会话有效。如需永久设置，请将配置添加到你的 shell 配置文件（如 ~/.bashrc、~/.zshrc 或 PowerShell profile）。

使用 Ollama 本地模型（可选）:

# Linux/macOS
export OPENAI_BASE_URL="http://localhost:11434/v1"

# Windows PowerShell
$env:OPENAI_BASE_URL = "http://localhost:11434/v1"

# Windows CMD
set OPENAI_BASE_URL=http://localhost:11434/v1

3. 运行示例代码

use rucora::provider::OpenAiProvider;
use rucora::agent::DefaultAgent;
use rucora::prelude::Agent;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let provider = OpenAiProvider::from_env()?;

    let agent = DefaultAgent::builder()
        .provider(provider)
        .model("gpt-4o-mini")
        .system_prompt("你是有用的助手")
        .build();

    let output = agent.run("你好".into()).await?;
    println!("{}", output.text().unwrap_or("无回复"));

    Ok(())
}

📚 文档

完整文档请查看 docs/README.md

新手入门

• 快速开始 - 5 分钟上手
• 用户指南 - 完整功能说明
• 示例集合 - 实际使用示例
• 常见问题 - FAQ

技能系统

• Skill 配置规范 - 配置文件完整说明
• Skill 配置示例 - 实际使用示例

架构设计

• 设计文档 - 系统设计理念
• Agent 与 Runtime - 核心架构说明
• 快速参考 - API 快速查询

项目文档

• 更新日志 - 版本更新记录
• 文档索引 - 完整文档列表

📦 项目结构

rucora/
├── docs/                      # 文档目录
│   ├── README.md              # 文档导航
│   ├── INDEX.md               # 文档索引
│   ├── quick_start.md         # 快速开始
│   ├── user_guide.md          # 用户指南
│   ├── skill_yaml_spec.md     # Skill 配置规范
│   └── ...
├── rucora/                  # 主库（实现聚合）
├── rucora-core/             # 核心抽象层
├── rucora-runtime/          # 运行时实现
├── rucora-cli/              # 命令行工具
└── examples/                  # 示例代码

🔧 环境变量

🎯 支持的 Provider

📝 更新日志

查看 CHANGELOG.md 了解最新版本和变更。

🤝 贡献

欢迎贡献代码、文档或建议！

📄 许可证

rucora 使用 MIT 许可证。