iii-cookbook

Runnable samples for iii across IoT, Edge, Agents, Backend APIs, and more. Each recipe is a small, self-contained project you can clone, run, and adapt.

Layout

iii-cookbook/
  <scenario>/
    <example>/
      README.md
      ...code

Scenarios group by domain (agents, iot, edge, backend-api, data-pipelines, realtime, workflows). Each example is a complete, runnable project with its own README and dependencies.

Requirements

• iii engine 0.11.2+ running locally or reachable over WebSocket
• Node 20+, Python 3.10+, or Rust 1.75+ depending on the sample

Install the engine:

curl -fsSL https://install.iii.dev/iii/main/install.sh | sh
iii

Or run it in Docker:

docker run -p 49134:49134 iiidev/iii:latest

Running a sample

cd <scenario>/<example>
# follow the example's README

Samples use the iii SDK for the language they're written in (iii-sdk on npm, iii-sdk on PyPI, iii-sdk on crates.io). Secrets load from .env; never inline keys.

Structure conventions

• Every example has its own README.md with prerequisites, setup, and run instructions.
• Every example registers its own functions and triggers — no shared global state across examples.
• Every example is pinned to a specific iii engine version and SDK version in its README.
• Samples that need external services (Redis, Postgres, a model provider) ship a docker-compose.yml next to the code.

Registry

Generally useful building blocks should not live here. If a worker is reusable across projects, publish it to the iii registry and reference it via iii worker add <name>. The cookbook shows how to compose those workers end-to-end, not replace them.

Official iii-hq workers carry an official flag in the registry. Community workers are unflagged.

Contributing

1. Fork and create a branch.
2. Add a new folder under the matching scenario.
3. Include a README.md, the code, and a minimal set of tests.
4. Open a PR. Keep it focused — one sample per PR.

Before opening a PR:

• Run the sample from a clean clone.
• Pin the iii engine version you tested against.
• Remove API keys, tokens, and absolute paths.

Release cadence

Refreshed every major iii release. Samples that break on a new release get tagged as needs-update until fixed or removed.

License

Apache License 2.0. See LICENSE.