Kiri Developers

REFERENCE

API reference

The Kiri SDK has two references for code and two for files, one of each for modules and for plugins, and a small HTTP door for plugins that run as containers. Every code reference shows Go, Rust, TypeScript and Python; pick yours with the language picker at the top of the page, and every page follows it.

The references

The references, and the part each coversA moduleYour codekiri.DB() · kiri.HTTP()Kiri checkskiri.yamlWhat it may touchport, database, sites, secretssix callsallowedSDK APIkiri.yaml referenceA pluginHandlers and clientplugin.check()The gate checkskiri-plugin.tomlKiri’s engine, windowplaces, checks, sharesanswers, callsallowedPlugin APIkiri-plugin.toml referencea container pluginthe door: HTTP, JSON
Which reference covers which part. A module's code makes the six calls, and Kiri checks each against kiri.yaml. A plugin's code registers handlers and calls the kiri client, and Kiri's gate checks each against the pass it made from kiri-plugin.toml. A container plugin can make the same calls over HTTP, through its door.

Errors at a glance

Each reference has the full list. These are the names to catch.

Error When
Modules Refused The call isn’t allowed by kiri.yaml
NotSet A listed secret has no value
Unavailable The database or a listed host can’t be reached
TooLarge A key or value is over the store’s limit
Plugins RefusedError The plugin’s pass doesn’t allow the call; the message names the permission line
UnavailableError A listed website or a settings address doesn’t answer
TimeoutError A call took longer than the handler has left

The names follow each language: kiri.ErrRefused in Go, kiri::Error::Refused in Rust, kiri.RefusedError in TypeScript, kiri.Refused in Python. See SDK errors and plugin errors.

Commands you build with

Everything runs in kiri, on your computer or in CI. There’s no separate toolchain to install: Kiri builds in its own builder.

Modules

Command What it does
kiri check . Reads the project and says which packages work as WebAssembly and what to change. --write makes a first kiri.yaml.
kiri run . Builds the module and starts it. --watch restarts on save, -d runs it in the background, --port N overrides the port.
kiri module logs NAME Its log; -f follows it.
kiri module stop NAME Stops a module running in the background.
kiri module rm NAME Removes it; --data deletes its store too.
kiri module db NAME A SQL prompt on its SQLite database.
kiri secret set APP NAME, kiri secret ls APP Sets a secret in the keychain without showing it; lists names, never values.
kiri module key create NAME Makes a signing key, kept in your keychain.
kiri module build . -t REF --sign KEY Builds an image of the module with its bill of materials, signed.
kiri module verify REF Checks a module’s signature.
kiri push REF, kiri pull REF Moves a module with its bill of materials and signature.

Plugins

Command What it does
kiri plugin new NAME --lang L Makes a plugin folder: kiri-plugin.toml, the code, tests/. L is typescript, go, rust or python.
kiri plugin dev Builds, shows the install prompt once, installs it for you alone, and reloads on save. --outline draws its places in the window.
kiri plugin check Checks the file and the built code agree, without running anything. Exits 1 on a problem.
kiri plugin test Runs tests/*.toml in the same box, with the same pass, against fake jobs.
kiri plugin build Packs the plugin into an OCI image. --tag names it for your own registry.
kiri plugin key create Makes a signing key; the first time, picks your publisher name. --for-ci prints a key for KIRI_PLUGIN_KEY.
kiri plugin publish Runs check and test, builds, signs and uploads to the marketplace. --withdraw VERSION --reason "…" takes a version back.

Every kiri plugin command takes --json. The commands people use to install and manage plugins, such as kiri plugin install and kiri plugin activity, will be in the Kiri docs under Plugins when 1.0 ships.

© 2026 Kiri · The SDK is open source under the Apache License 2.0 · Docs · runkiri.com