Developer Reference
Developer Reference is where you look things up once you're building with Avocado. It holds task guides for working with Avocado OS, and the reference docs for each Avocado tool and API.
Start with Learn. It takes you from installing the CLI to running your code on a device, step by step. Come back here when you need detail on a specific topic.
Guides
Topics for developers working with Avocado, grouped by what you're trying to do.
References
Our repo of demos and fully working projects, from a shell heartbeat to React, Rust and vision apps. A great starting point for your own project.
Browse references →Development
Guides for everyday development: provisioning, sideloading, container dev mode, hardware-in-the-loop, remote tunnels, and searching for packages in our feeds.
Open the guides →Security
The security features Avocado OS supports, in detail: boot signing, dm-verity, and encrypted /var.
Read about security →Advanced
In-depth guides for going further: cross-compilation, custom kernels, device tree overlays, seeding /var, and customizing the rootfs and initramfs.
Go deeper →Tools and APIs
Reference docs for each part of Avocado: commands, configuration, and APIs.
Avocado CLI
Runs on your machine. Creates, builds, provisions, and deploys Avocado OS projects, and talks to Avocado Connect.
CLI reference →Avocado Connect API
The REST API behind Avocado Connect, for automating devices, projects, runtimes, and deployments across your fleet.
API reference →Avocado Control
avocadoctl runs on the device. It manages system extensions, runtimes, and OS bundles, and exposes a Varlink API.
avocadoctl reference →Stone
Turns a manifest and build artifacts into disk images, OTA bundles (.aos), and provisioned devices.
Stone reference →Meta Avocado
The Yocto distro layer Avocado OS is built from, with BSP layers for NVIDIA, NXP, Raspberry Pi, Qualcomm, and more.
Layer reference →MCP
The Avocado OS MCP server lets AI assistants scaffold projects, find packages, provision, deploy, and debug for you.
Set up MCP →