¶Elyra Framework documentation

A Rust + Svelte 5 framework for hyper-responsive desktop apps — Laravel's ergonomics (container, providers, a typed bridge), compiled and binary, with no runtime overhead. The CLI is Ratatosk (rata).

Also hosted at elyracode.com/framework.

¶Start here

• Getting started — install, scaffold, run.
• Architecture — the big picture and the Laravel map.
• Configuration (elyra.toml) — the project descriptor.

¶Backend (Rust)

• Validation — Laravel-style input validation for commands (Validator).
• Commands — #[command], Ctx, Result commands.
• Container & providers — DI + wiring.
• Middleware — the dispatch pipeline.
• Events — EventBus, batched Rust→frontend push.
• Windows — window config, multi-window, control, persistence, file drop.
• Application menu — native app menu from App::menu (macOS).
• About dialog — built-in About window from App::about.
• System integration — dialogs, shell-open, clipboard, notifications (system feature).
• Global shortcuts — OS-level keyboard shortcuts (shortcuts feature).
• Autostart — launch at login (autostart feature).
• Sidecar processes — spawn + stream child processes (sidecar feature).
• Single-instance & deep-linking — one instance + custom URL schemes.
• System tray — tray icon + menu (tray feature).
• Auto-updater — ed25519-verified updates (updater feature).

¶Data (Rust)

• Settings store — persistent key-value store (store / Store).
• Cache — in-process TTL cache facade (cache / Cache), Askr-compatible surface.
• Rate limiting — cache-backed RateLimiter (Laravel-style).
• Storage — jailed filesystem disk facade (storage / Storage).
• Queue — in-process background job facade (queue / Queue).
• Scheduler — recurring background jobs (Scheduler).
• Shared substrate — the substrate-core contract shared with Askr.
• Database — SQLite / MySQL / Postgres via one Database.
• AI SDK — agents, tools, structured output, images, embeddings (ai feature).
• Migrations — rata migrate, batches, rollback.
• Models — #[derive(Model)] Active Record + query builder + relations.

¶Frontend & bridge

• Frontend runtime — @elyra/runtime: invoke, channel, api.*.
• UI components — dialogs, toasts, ⌘K command palette, context menu.
• Codegen — specta → TypeScript types + typed api.*.
• Logging — the Log facade, levels, file rotation
• Testing — TestApp, event assertions, TestShell
• Secrets — OS keychain storage
• Releasing — version bump, tag, crates.io order
• Security — the IPC surface, capabilities, CSP, secrets
• Wire format — the binary IPC contract.

¶Tooling

• Ratatosk CLI — new, dev, codegen, build, bundle, migrate.
• Roadmap — milestones and what's deferred.
• Changelog — released versions and changes.

¶Crate layout

framework/   elyra          — App, Container/Ctx, Command, events, shell (tao+wry)
macros/      elyra-macros   — #[command] and #[derive(Model)]
database/    elyra-db       — Database, migrations, models (GUI-free)
ratatosk/    ratatosk       — the `rata` CLI
runtime/     @elyra/runtime — invoke(), channel(), generated api.*
example/     elyra-example  — the demo app / DX benchmark

¶Cargo features (on the elyra crate)

elyra = { version = "0.1", features = ["database", "tray", "updater"] }