Skip to main content

Overview

Beyond publishing to the Omi app store, you can open-source your app by contributing it to the BasedHardware/omi repository. This gives your app more visibility, lets other developers learn from and build on your work, and contributes to the Omi ecosystem.

Community visibility

Your app is discoverable by Omi developers and users

Learn from each other

Other developers can read, fork, and build on your work

Repository structure

Open-source apps live in the plugins/ directory:
Each app should be a self-contained directory with everything needed to run it independently.

Step-by-step guide

1

Fork the repository

Go to github.com/BasedHardware/omi and click Fork to create your own copy.
2

Create your app directory

Create a new folder under plugins/ with a descriptive name:
Use lowercase names with hyphens in place of spaces, such as meeting-summarizer, crm-sync, or daily-journal.
3

Add your app code

Structure your app with these files at minimum:
Never commit secrets, API keys, or credentials. Use .env.example with placeholder values and add .env to .gitignore.
4

Write a great README

Your README is the first thing developers see. Include:
5

Test thoroughly

Before submitting, make sure:
  • App runs from a clean install following your README
  • All environment variables are documented in .env.example
  • No hardcoded secrets or API keys in the code
  • Webhooks handle errors gracefully
  • Code is clean and reasonably commented
6

Create a branch and commit

7

Open a pull request

Push your branch and open a PR against main:
Then go to GitHub and create a Pull Request with:
  • Title: feat: add [your-app-name] plugin
  • Description: What the app does, how to use it, and any relevant context
  • Screenshots/demo (if applicable)

PR review checklist

Our team will review your PR against these criteria:
  • Clean, readable code
  • No unnecessary dependencies
  • Proper error handling
  • No hardcoded secrets or credentials
  • Complete README with setup instructions
  • .env.example with all required variables
  • Clear explanation of what the app does
  • App runs independently from its directory
  • All dependencies listed in requirements.txt
  • No modifications to core Omi code
  • Respects user privacy
  • No harmful or inappropriate content
  • Provides genuine value to users

Tips for a successful contribution

Start simple

A well-documented simple app is better than a complex, undocumented one

Show, don't tell

Include screenshots, GIFs, or a demo video in your README

Be responsive

Respond to review feedback quickly to get your PR merged faster

Follow existing patterns

Look at existing apps in plugins/ for style and structure inspiration

Publish to the app store

Submit your app to the Omi app store (no code required)

Building apps

Learn how to build Omi apps from scratch

Contribution guide

General contribution guidelines

Integration apps

Build webhook-based integrations