Before you start
1
Check Rust
The SDK uses the No Rust yet? Install it from rustup.rs.
2024 edition, which needs Rust 1.85 or newer. A recent stable toolchain works.2
Check git and the GitHub CLI
aomi-git uses git to push your App and your gh login to reach the platform repo.gh says you are not logged in, run gh auth login.3
Install the toolchain
This installs the builder binaries. The There is no
cli feature builds aomi-build and aomi-git, the tool that ships your App. Add dev-runtime to also get aomi-run, which lets you chat with your App locally before you ship.--version flag, so confirm the install with --help:Write your App
Your App is three small files. Make a folder and add them.1
Create the folder
2
aomi.toml
This tells the platform who your App is and where it ships.
aomi.toml
3
Cargo.toml
Your App compiles to a
cdylib. Pin aomi-sdk to the exact version the platform requires, today =0.1.20.Cargo.toml
The exact version lives in
platform.json in the community-apps repo, under required_sdk_version. The runtime loads a plugin only if it was built against that version.4
src/lib.rs
One tool plus the The
dyn_aomi_app! macro that registers it. This tool takes a name and returns a greeting.src/lib.rs
DESCRIPTION is what the model reads to decide when to call your tool, so write it as a trigger. namespaces = [] means your App asks for no host powers like wallet signing.Build and ship
1
Build it
2
Commit your files
Deploy works from a clean commit. Add a
.gitignore so build output does not dirty the tree.3
Check the plan
A dry run shows the plan and runs the checks. It pushes nothing.Every Preflight line should read If a line fails, fix what it names in your
[ok]:aomi.toml and run the dry run again.4
Deploy
apps-hello-aomi-<short-commit>.5
Watch CI
ci line reads [ok] green and release says it is ready to activate, you are set. A build takes a few minutes.6
Get access (first time only)
The first time you ship to a platform, ask ops for access. This runs once, not per deploy.This posts a request to the Aomi apps Discord. Ops then do two things: they invite your GitHub account to the platform repo as a collaborator, and they email you a per-app activation code. The code arrives by email, never over Discord.
7
Activate your release
Once CI is green and you hold your per-app code, you activate the release yourself. Set the code as The backend fetches your release, validates it, and loads it. Within a few minutes your
AOMI_APP_ACTIVATION_TOKEN.greet tool appears in the agent for new chats.What you have now
You have a deployed Aomi App on the live runtime. You wrote three files, deployed with
aomi-git deploy, and activated the release with your per-app code. Your greet tool now runs inside real chats.Building an App
The anatomy: tools, arguments, the preamble, and host namespaces.
Deploy and activate
The full shipping process, the validation pipeline, and troubleshooting.
Common errors
The errors you are most likely to hit, each with its fix.