Skip to main content
Developers

Build on BizPlug

BizPlug's plug-ins are open source. Add a card theme, a menu layout or a whole industry with one pull request, build plug-ins for your clients from your terminal, or connect your own agent and systems.

Contribute to the open-source plug-ins

The plug-in packages, the card's themes and layouts, and the list of industries are in a public repository on GitHub, msg2ai/bizplug-plugins, under the MIT License. A contribution is a pull request that adds one file or one folder. You need a GitHub account, Git and Node.js 18 or later: no BizPlug account, no keys and no server of your own, except for a plug-in you host yourself.

Each kind has a check that runs the same rules BizPlug runs. Run it before you open the pull request; the same check runs on the pull request, and the BizPlug team reviews it there.

A card theme

Five colours for a business's card in ChatGPT and Claude, next to the 5 built-in themes.

You add
themes/<id>.json
Check
npx tsx themes/check-theme.ts themes/<id>.json
Once merged
Offered to every business in the portal within about ten minutes.
Read THEMES.md

A menu layout

How the card's menu is organised: one pure function from the card's data to HTML, and its styles.

You add
community/layouts/<id>/
Check
npx tsx layouts/check-layout.ts community/layouts/<id>
Once merged
In the repository, credited to you; offered in the portal once the BizPlug team adds it.
Read LAYOUTS.md

A new industry

A plug-in for a whole kind of business, on one of the five engines. Only when no existing industry fits.

You add
community/industries/<slug>.json
Check
npx tsx industries/check-industry.ts community/industries/<slug>.json
Once merged
Merging is the release: its plug-in, its page and its place in the portal go live with the website's next build.
Read INDUSTRIES.md

A plug-in of your own

An MCP server you host, with a plugin.json, an mcp.json and a README, so others can find it and add it in ChatGPT.

You add
community/plugins/<name>/
Check
It works in ChatGPT developer mode with the address in its mcp.json
Once merged
In the repository for anyone to use; listed in the marketplace once its listing is agreed with you.
Read CONTRIBUTING.md

An existing industry first. An industry is a kind of plug-in, not a business: every business in it gets its own plug-in with its own name, services, prices and colours. A yoga studio uses Fitness & Gyms and a vegan restaurant Restaurants & Food Service. Propose a new industry only when what its customers do, or the plug-in's words, would be wrong in every existing one; the industry check lists the closest ones for you.

Watch it step by step

Every command and what it prints, from forking the repository to the pull request. No sound. The full written steps are in the how-to guide.

Add a card theme to BizPlug, step by step (1:04)The written steps
Add a menu layout to BizPlug, step by step (1:20)The written steps
Add a new industry to BizPlug, step by step (1:31)The written steps

The BizPlug CLI

The CLI does from a terminal what the portal does in the browser, for the plug-ins in your own account: add a plug-in from a business profile, send its files, ask for a test or production deploy, upgrade it, and set its card's colours and theme. One account can hold a plug-in per business, so it suits agencies building plug-ins for several clients. It needs Node.js 18 or later and nothing else.

  1. 1The CLI is not on npm yet. It will be published as @bizplug/cli; until then npx @bizplug/cli does not work. Every step below is what it does once published.
  2. 2You need Node.js 18 or later and a BizPlug account (sign up in the portal).
  3. 3bizplug login shows a code and opens the portal: check the code and press Approve. The CLI then holds an API key for your account on your computer only.
  4. 4bizplug push my-business.json sends a business profile, split into the plug-in's files and checked as an upload is; bizplug request <industry>/<business> test asks for a test deploy.

Publishing stays with the BizPlug team: the CLI asks for a deploy, and a person signs off before anything goes live. For CI, set BIZPLUG_API_KEY to a key made under API in the portal instead of signing in.

Every command and the profile file
# once @bizplug/cli is on npm
$ bizplug login
Open this link, sign in to BizPlug and approve the code <code>:
  https://www.bizplug.ai/portal/api/cli?code=…
Waiting for approval (10 minutes)…
✓ Signed in as you@example.com. Key saved in ~/.config/bizplug/config.json

$ bizplug push harbour-kitchen.json --request
$ bizplug status restaurants/harbour-kitchen
$ bizplug card harbour-kitchen --theme ocean
$ bizplug request harbour-kitchen prod

API, agents and webhooks

Not on GitHub? Propose a theme, a layout or an industry with a form, and the team adds the file for you. Questions: info@bizplug.ai.