Modules

Extend bohay in any language

A module is a plain GitHub repo with a manifest and some commands. Bash, Python, Lua, Rust, Node, anything your machine can run. No SDK, no plugin runtime, no registry to sign up for.

Write a module → How installing works
  1. 1

    Find one

    Browse below, or search from the terminal. Both read the same bohay-module GitHub topic. 

    bohay module search
  2. 2

    Review, then install

    Install prints every command the module declares and waits for your confirmation before anything runs. 

    bohay module install owner/repo
  3. 3

    Use it

    It shows up in Settings → Modules with its own settings, and wherever it declared itself: a dock, a pane, a right-click. 

    bohay module list

Community modules

Browse the topic →

Start from a working example

i See all samples →

Three complete modules ship in the repo, one per language, each covering a different part of the surface. Copy one, change its id, and you have a module.

branch-dock example
bohay/examples

A sidebar dock listing the active node's git branches. Click one to check it out.

Shell 3 files 132 lines
dockstartupsettings
bohay module link ./examples/modules/branch-dock
agent-ping example
bohay/examples

Posts a webhook when an agent goes blocked, so you know without watching it.

Python 2 files 131 lines
eventssecretsright-click
bohay module link ./examples/modules/agent-ping
scratch-pane example
bohay/examples

Right-click a pane to open a scratch notepad beside it, and stash the selected text into it.

JavaScript 4 files 139 lines
panesselectiontabs
bohay module link ./examples/modules/scratch-pane
esp-idf example
bohay/examples

Build, flash and monitor ESP32 boards. Flashing stops the serial monitor and brings it back in the same pane, so the log from before the flash is still there.

Shell 12 files 755 lines
dockpanessettings
bohay module link ./examples/modules/esp-idf
deck example
bohay/examples

Present a Markdown file as slides in a pane. Split on a rule, arrow keys to move, r to reload.

Python 5 files 821 lines
panessettings
bohay module link ./examples/modules/deck
Publishing

Getting listed takes one click

There is no submission, no review queue, and no account. Push a public repo with a bohay-module.toml at its root, then add the bohay-module topic to it on GitHub. This page and bohay module search both pick it up on their next run.

  1. Put bohay-module.toml in the repo root (or a subdirectory).
  2. On GitHub: About → ⚙︎ → Topics, add bohay-module.
  3. Tell people to run bohay module install you/your-module.

What makes a good listing

  • A one-line repo description: it is the card text here.
  • A README showing what it adds, with a screenshot.
  • Any tools it needs (jq, node, …) stated up front.
  • A min_bohay_version you have actually tested.

A note on trust

A module is ordinary code that runs on your machine as you, with your environment and your full bohay CLI. That openness is the point, and a little judgment keeps it safe. Install from people you trust, and skim the manifest first: bohay module install shows you every command a module declares and asks before running anything. Builds run with a scrubbed environment, and a manifest cannot change between the preview and the install. bohay validates and isolates, but it does not sandbox: third-party modules come from their authors, not from bohay.

Read the full trust model →