Skip to content

Developer Guide

Build the host, contribute plugins, and understand the RPC contract.

Page Topics
Plugin RPC API Configure, GetView, DoAction, ViewData
Writing a Plugin Step-by-step from stub to plugins.meta.yaml
Packaging & Index Releases, index.yaml, Package Manager
Contributing Setup, PR checklist

Prerequisites

  • Go 1.25+
  • Docker (optional — use omo-playground)
  • KeePassXC (optional)

Common commands

make all          # build host + install all plugins to ~/.omo/plugins
make plugin-redis # rebuild a single plugin quickly
make clean        # remove local ./omo binary (keeps ~/.omo)
make purge        # remove ~/.omo entirely (destructive)

For local Redis/Kafka/Postgres/kind/Argo CD stacks, use omo-playground (make setup), not make dev-setup (the dev/ tree is currently missing from the main repo).

Study a full example: plugins/redis/.