PUBLISH
Company plugins
A company plugin is a plugin your company keeps for its own people, such as a place to deploy to your own platform or a check for your own registry rules. It’s written, tested and built like any other plugin. What differs is where it goes: into your own registry and your company’s list in Kiri Cloud, never the public marketplace. This page is for the person who writes one. What admins set and what members see is in the docs, under Company rules.
How a company plugin gets to people
Build, sign and add it
-
Write and test it as you would any plugin:
kiri plugin new,kiri plugin dev,kiri plugin test. See Your first plugin and Test and publish. -
Make a signing key on the company’s publisher account with
kiri plugin key create, and put the company’s publisher name inpublisher. Members see “signed by” that name in the prompt. For CI,kiri plugin key create --for-ciprints a key to keep in the CI’s secrets asKIRI_PLUGIN_KEY. -
Build it into an image, signed, and push it to a registry your people can reach.
-
Ask an admin to add it. The admin runs
kiri team plugin addwith the image’s address, or adds it on the team’s Company plugins page in Kiri Cloud, and reads the prompt before saying yes.
$ kiri plugin build --tag registry.example.com/acme/deploy-acme:2.3.0 --sign acme-release
✓ acme-deploy 2.3.0 · WebAssembly 820 KB
✓ built registry.example.com/acme/deploy-acme:2.3.0
✓ signed by acme-release
$ kiri push registry.example.com/acme/deploy-acme:2.3.0
# the admin
$ kiri team plugin add registry.example.com/acme/deploy-acme:2.3.0
acme-deploy 2.3.0 · signed by acme-release ✓
Where it shows:
• Be a place to deploy: Acme platform. Get a project's compose file after
Kiri builds and pushes it
What it may see and reach:
• Reach these websites: deploy.example.com
Add it to Acme's company plugins? [y/N] y
✓ added; allowed for PlatformKiri’s reviewers don’t look at a company plugin: the admin who adds it does, from the same prompt every member will see. It runs in the same box with the same gate as any plugin, and the company’s rules can’t give it more than its prompt lists. A new version goes the same way: build, push, and the admin adds it, seeing only the new lines if it asks for more.
Acme › Company plugins
Write plugins that work under company rules
Company rules apply to every plugin, yours and anyone else’s, whoever made it. A plugin that works well under them is one a company can require for everyone.
| A company can | So your plugin should |
|---|---|
Block a permission line for every plugin, such as --needs containers=manage, secret=program, sites=any, section or notifications |
Ask for less. A plugin whose prompt has a blocked line is refused for the whole company, so a line you don’t need costs you every person there. |
| Turn off own sections | Work without its section. People can say no to a section at install too; keep the core of the plugin in a menu item, a tab or a check, and treat the section as extra. |
| Turn off system notifications | Not rely on them. With them off, kiri.notify({ system: true }) shows as a notice in the window if you may show notices, or is dropped and counted. |
| Lock a setting, such as the server everyone deploys to | Read the setting each time with kiri.settings.get, and not keep a copy. A locked field still comes back as usual; the person just can’t change it. |
Require your check and make silence a block (--if-silent block) |
Answer fast and from what you already have. A check that asks a website on every pull will block people when the website is slow; read your own store, as the Trivy scanner reads its saved scans. |
| Pin a version | Keep your store’s format readable by older versions, and older formats readable by newer ones. Some teams stay on an old version for months. |
Allow only some of your ways to share or places to deploy, such as --way funnel |
Keep each way’s name stable. A rule names it; renaming a way breaks the rule and the person’s default. |
| Require your plugin, installed at sign-in, or in CI before the first pull with no prompt | Do something sensible before its settings are filled in: a check that has no server address yet should allow and say why in its log, not block everything. |
When a person is in two teams with different rules, the stricter rule wins. When a rule blocks your plugin after it’s installed, Kiri switches it off rather than removing it, so its settings and store come back if the rule is lifted.
What the company sees
The company’s record in Kiri Cloud shows installs, updates and removals of your plugin, and each block and override, with who and when. It never shows what the plugin read or reached, tokens, or the rest of a person’s activity record: those stay on their computer. Write your plugin’s log the same way. It goes in the person’s own activity record, not the company’s, but don’t put tokens or file contents in it.
© 2026 Kiri · The SDK is open source under the Apache License 2.0 · Docs · runkiri.com