Native SDK Documentation

Pages

1. OverviewWhat Native SDK exposes, who should use it, runtime assumptions, and the first docs routes from install to a running window.
2. InstallationInstall @native-sdk/cli, platform package layout, prerequisites, and success signals for a working native binary on each host OS.
3. QuickstartCreate an app with native init, run native dev, edit .native markup and Zig Model/Msg/update, and verify the first live window.
4. Agent skillsShipped skill packs for core authoring, Native UI, and automation, including how agents discover and apply them via the CLI.
5. App modelModel, Msg, and update loop wiring, hot reload boundaries, and how markup binds values without mutating state.
6. Native UI markupElements, attributes, flex layout, bindings, expressions, and editor/LSP support for .native views compiled into the binary.
7. State and data flowDerive-don't-store patterns, message dispatch, text editing paths, and effects as the only channel for side effects.
8. ThemingDesign tokens for color, radius, and typography, live theme re-resolution, chrome passes, and token-only restyles across apps.
9. ComponentsBuilt-in component catalog inventory, preview generation, eject workflows, and identity constraints for reusable widgets.
10. Windows and surfacesMulti-window apps, native surface composition, OS window chrome, GPU surfaces, and host presentation on macOS and desktop peers.
11. Menus, dialogs, and trayApp menus, context menus, system dialogs, tray status items, and how OS-owned UI coexists with engine-drawn widgets.
12. Commands and keyboard shortcutsSingle command routing across toolbar, menu, tray, shortcut, and bridge entry points with keyboard binding constraints.
13. CapabilitiesGuarded OS services for notifications, clipboard, credentials, dialogs, file drops, and effect-channel access boundaries.
14. Web enginesWebView composition on desktop hosts, CEF tooling and hosts, engine flags, and when native-rendered UI coexists with web content.
15. Bridge and builtin commandsHost-to-content bridge payloads, responses, async dispatch, builtin commands, and permission boundaries for WebView apps.
16. Frontend projectsManaged React, Next, Svelte, and Vue shells, frontend asset pipeline, and native dev server integration for web frontends.
17. Embedded appC embed ABI, host view controllers, mobile canvas libraries, and experimental iOS/Android host shims around the desktop-first runtime.
18. AutomationEmbedded automation server: accessibility snapshots, widget driving, record/replay, deterministic screenshots, and agent command surface.
19. TestingFull-loop UI tests via native test, headless truth drivers, effect tests, and frame-level verification without a display server dependency.
20. Testing in CICI workflows, gate scripts, platform truth drivers, and eval harness wiring for reproducible headless and hosted checks.
21. PackagingFrom ReleaseFast binaries to distributable app bundles: assets, build graph outputs, and packaging layout expectations.
22. Code signingCodesign tooling, framework and native binary copy steps, and signing constraints for macOS and related package pipelines.
23. Updates and package distributionUpdate channels, npm multi-platform package layout, version sync checks, and binary distribution for @native-sdk packages.
24. CLI referencenative init, dev, check, test, build, automate, doctor, and skills commands with flags, outputs, and failure modes.
25. Runtime and effectsRuntime API surface, effect kinds for spawn/fetch/file/audio/clipboard, cancellation, worker wakes, and deterministic frame limits.
26. Platform support and securityHost capability matrix for macOS, Linux, Windows, and experimental mobile, plus bridge permission and capability security boundaries.
27. ContributingLocal development setup, agent guidance, release and changelog merge process, and pre-1.0 contribution expectations.