Developer Guide
Welcome to the Radium Developer Guide. This guide helps you extend Radium's capabilities, understand its architecture, and contribute to the project.
Getting Started
New to Radium development?
- Architecture Overview - Understand Radium's architecture
- Agent System Architecture - How agents work
- Extension Development - Create extensions
Architecture Documentation
System Architecture
- Architecture Overview - High-level system architecture
- Agent Configuration System - Agent configuration architecture
- Checkpoint System - Checkpoint and resume architecture
- Engine Abstraction - AI provider abstraction layer
- TUI Architecture - Terminal UI architecture
Design Documents
- Persona System Architecture - Persona system design
Architecture Decision Records (ADRs)
- ADR 001: YOLO Mode Architecture - YOLO mode design decisions
Extending Radium
Extension System
- Extension System - Overview of extension system
- Creating Extensions - Build extensions
- Extension Architecture - Technical architecture
- Extension API Reference - API documentation
- Extension Integration Guide - Integration patterns
MCP Integration
- Extension MCP Integration - Integrate MCP servers
- MCP Architecture - MCP system architecture
Context Sources
- Extending Sources - Add custom context sources
Development Guides
Development Process
- Agent Instructions - Instructions for AI agents working on Radium
- Colors - Color scheme and theming
- Deep Analysis Improvements - Analysis system improvements
Testing
- Testing Coverage Analysis - Coverage analysis
- Testing Backlog - Testing improvements needed
Guides
- JSON Schema Guide - Using JSON schemas with agents
Roadmap & Future Architecture
Technical Roadmap
- Technical Architecture Roadmap - Technical implementation roadmap
- Core Architecture Specification
- Component Foundry Implementation
- Global Component Graph Design
- Agentic Component Integration
- Performance & Scalability
Vision & Innovation
- Vision & Innovation - Long-term vision
- Component Foundry Pattern (CFP)
- Durable Autonomous Continuous Remediation (DACR)
- Durable Recursive Component Generation (DRCG)
- Autonomous Component-Centric Assembly (ACCA)
Protocol Specifications
- Protocol Specifications - KOR protocol roadmap
- Governance & Operations - Governance roadmap
API Reference
- API Overview - Complete API documentation
- Context Cache API - Context caching API
- Extension API - Extension system API
- Hooks API - Hooks API
Codebase Structure
Core Crates
radium-core: Core backend with gRPC server and orchestrationradium-orchestrator: Agent orchestration engineradium-models: Data models and typesradium-abstraction: Abstraction layers
Applications
apps/cli: Command-line interfaceapps/tui: Terminal user interfaceapps/desktop: Tauri-based desktop application
Packages
packages/api-client: TypeScript API clientpackages/shared-types: Shared TypeScript typespackages/state: State managementpackages/ui: UI components
Development Workflow
Building
# Build all crates
cargo build --workspace
# Build specific crate
cargo build -p radium-core
# Build with optimizations
cargo build --release
Testing
# Run all tests
cargo test --workspace
# Run tests for specific crate
cargo test -p radium-core
# Run with coverage
cargo llvm-cov --workspace --html
Code Quality
# Format code
cargo fmt --all
# Lint code
cargo clippy --workspace
# Check for issues
cargo check --workspace
Contributing
Getting Started
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests
- Submit a pull request
Code Standards
- Follow Rust style guidelines
- Write comprehensive tests
- Document public APIs
- Update relevant documentation
Pull Request Process
- Ensure all tests pass
- Update documentation
- Add changelog entry if needed
- Request review
Architecture Patterns
Component Foundry Pattern
Systematic approach to creating, validating, and composing reusable components.
Status: 📋 Planned Learn more: Roadmap: Component Foundry
Durable Autonomous Continuous Remediation (DACR)
Self-healing systems that maintain component quality over time.
Status: 🔮 Future Learn more: Roadmap: DACR
Durable Recursive Component Generation (DRCG)
Components that generate other components recursively.
Status: 🔮 Future Learn more: Roadmap: DRCG
Autonomous Component-Centric Assembly (ACCA)
Systems that automatically assemble themselves from available components.
Status: 🔮 Future Learn more: Roadmap: ACCA
Resources
Documentation
- User Guide - User-facing documentation
- CLI Reference - CLI documentation
- Features - Feature documentation
External Resources
- GitHub Repository - Source code
- Issues - Bug reports and feature requests
- Discussions - Community discussions
Next Steps
- Architecture Overview - Deep dive into architecture
- Creating Extensions - Build your first extension
- API Reference - Explore the API
Ready to contribute? Start with Architecture Overview or Creating Extensions.