Developer Guide
Welcome to the Ruri 琉璃 Developer Guide! This section is for developers who want to build on top of Ruri, integrate it into their own applications, or contribute to the project.
What's in This Section?
| Page | Description |
|---|---|
| Getting Started | Set up your development environment, build from source, and understand the project structure |
| API Usage Guide | Practical guide to using Ruri's REST API programmatically — authentication, common patterns, code examples, and error handling |
| Integration Guide | Integrate Ruri into your applications — REST API, ACP for IDEs, MCP server development, webhooks, and custom chat clients |
Who Is This For?
- Application developers who want to build tools or services that interact with Ruri programmatically
- IDE plugin authors who want to integrate Ruri as an AI coding assistant
- Platform integrators who want to extend Ruri to new chat platforms or services
- Contributors who want to understand the codebase and submit patches
Quick Links
- API Reference — Complete HTTP endpoint reference
- MCP Client — Connect external tool servers to Ruri
- ACP Server — Use Ruri as an AI assistant in your IDE
- Skills — Extend Ruri's behavior with custom skills
- Platforms — Connect to DingTalk, Discord, and WeChat
提示
If you're new to Ruri entirely, start with the Getting Started guide for end-user setup, then come back here for developer-focused content.