WINDOW PLACES
Every place in the window
A plugin never gets a panel to fill as it likes. It names the places it wants in its manifest, each place becomes one line in the install prompt, and Kiri draws what the plugin sends there in Kiri’s own look. Here they all are at once, as people will see them with Coolify, Tailscale and the Trivy scanner installed. Each number links to the page for that place.
Compose
shop
- 1A note in the status bar[window] status
- 2Items in a row's menu, and commands[adds] actions, commands
- 3A tab, and a line at the top of a page[window] tabs, facts
- 4A page under the Plugins heading[window] page
- 5A section of its own, with its settings button[window] section
- 6A choice in Share with, Deploy to or Scan with[adds] share, deploy, scan
- 7A column of badges in a list[window] columns
- 8Notices, and system notifications[window] notices, notifications
- 9Fields in Settings[[settings]]
- 10Checks before pull, build and run[adds] checks: no place of their own
Each place, its key and its limit
| Place | Key | Handler or call | Limit | Prompt line |
|---|---|---|---|---|
| Status bar note | [window] status |
kiri.status.set, kiri.status.clear |
One note, 24 characters, a tone; a panel of five lines and two buttons | Show a note in the status bar |
| Menu items | [adds] actions |
plugin.action |
Two at the top, then a submenu; 32 characters | Add items to the menu of: kinds |
| Commands | [adds] commands |
plugin.command |
Under kiri plugin NAME only |
Add commands: kiri plugin name a, b |
| Tab | [window] tabs |
plugin.tab |
One per kind of page, 16 characters | Add a tab to: kinds |
| Line at the top | [window] facts |
plugin.fact |
One per page | Add a line to the top of: kinds |
| Column | [window] columns |
plugin.column |
One per list; heading and badges 12 characters | Add a column to: lists |
| Page | [window] page |
plugin.page |
One page, 20 characters | Add a page to the sidebar: label |
| Section | [window] section |
plugin.page, per page |
Two to five pages; never with a page | Add its own section to the sidebar (asked separately) |
| Share with, Deploy to, Scan with | [adds] share, deploy, scan |
plugin.share, plugin.deploy, plugin.scan |
Joins Kiri’s menu, never a button of its own | Be a way to share, Be a place to deploy, Be a scanner |
| Settings | [[settings]] |
kiri.settings.get, plugin.settings.check |
Six field types | None, except for reach and secrets |
| Notices | [window] notices, notifications |
kiri.notify |
One every 10 s; a system one a minute, once switched on | Show notices in the window |
| Checks | [adds] checks |
plugin.check |
2 s to answer, up to 10 | Check before pull (build, run) |
A plugin doesn’t have to show in the window at all. A check with no screen is a complete plugin: what it decides shows wherever the pull or the run already shows.
What every place has in common
Kiri draws it. You send text, a tone, blocks or cells, and Kiri draws them with its own parts, in the person’s theme, accent colour, text size and language direction. No HTML, script, image or font from a plugin ever enters the window, so a plugin can’t pass itself off as part of Kiri, such as a fake sign-in box.
Your mark is on it. Your icon on your colour, from mark in your manifest, sits beside everything your plugin adds, so people always know which plugin said what.
It comes after Kiri’s own. Tabs after Kiri’s tabs, menu items after Kiri’s items and choices with Remove last, notes after Kiri’s share count, pages under the Plugins heading below Kiri’s groups. Kiri’s own items never move, however many plugins someone adds.
People can hide it. A right-click hides a note, a column, a page or a section, and your plugin keeps working. So nothing should live only in one place: a note’s panel should lead to a page or a link people can also reach from your plugin’s page in Plugins.
Words, languages and sleep
Kiri tells your plugin the window’s language as kiri.lang, and translates the labels in your manifest from your own lang/ files, with English when there’s none. Labels have hard limits, and German is longer than English: kiri plugin dev --outline draws a dashed line round each of your places with how much of its limit you use.
While Kiri’s VM sleeps, the window keeps the last note, tab and page your plugin sent. A timer in your plugin never wakes the VM; a click on one of your buttons does. A plugin that’s switched off has no places at all, and comes back with them when it’s switched on.
© 2026 Kiri · The SDK is open source under the Apache License 2.0 · Docs · runkiri.com