Orbit SDK

Orbitrs SDK is a workspace containing the core Orbit UI framework, CLI tooling, static analysis tools, public assets, and comprehensive documentation to power Rust-first UI across web, desktop, native, and embedded targets.

Development Priority

Important: The SDK itself is currently used for personal development purposes and improvements to it are considered non-essential. The primary focus is on core framework development. Contributors should prioritize work on the core components (orbit, orbiton, orlint) rather than SDK enhancements.

Recent Progress (May 2025)

• Fixed build target conflicts in examples project structure
• Created comprehensive examples demonstrating props and events system
• Implemented component lifecycle demonstration
• Added WGPU renderer examples for 3D capabilities
• Refactored project organization for better maintainability
• Added MCP server for AI agent integration (May 25, 2025)

See Milestone 1 Tracking for detailed progress updates.

Workspace Structure

Component	Path	Description
Core Framework	orbit/	Orbit UI framework with Skia & WGPU rendering
CLI Tools	orbiton/	Command-line interface for development, building, and deployment
Linting & Analysis	orlint/	Static analysis, linting, and validation for .orbit files
AI Integration	orbit-mcp/	Model Context Protocol server for AI agent integration
Public Assets & Site	public/	Organization website, assets, and examples
Documentation	docs/	Guides, API references, tutorials, roadmap, and progress reports

Getting Started

Build the entire workspace

cargo build --workspace

Install and run the CLI

cargo install --path orbiton
orbiton new my-app
cd my-app
orbiton dev

Run tests and lint

cargo test --workspace
orlint lint

GitHub Copilot CLI Integration

We offer GitHub Copilot CLI integration to enhance your development experience with Orbit Framework. To set it up:

# Run the setup script
./scripts/setup-copilot-cli.sh

# Or manually install
gh extension install github/gh-copilot

# Get command explanations
gh copilot explain "cargo test -p orbit"

# Get command suggestions
gh copilot suggest "Update my branch with latest changes"

See GitHub Copilot CLI Guide for more details.

Documentation

Explore detailed guides, API references, and tutorials in docs/README.md.

Contributing

See CONTRIBUTING.md for guidelines on reporting issues, contributing code, documentation, and other improvements.

Crafted with ❤️ by the Orbitrs Team