The BizPlug CLI does from a terminal what the portal does in the browser, for the plug-ins in your own account. It needs Node.js 18 or later and nothing else.
The CLI is not on npm yet. It will be published as @bizplug/cli; until then the npx @bizplug/cli commands below do not work. The steps are what it does once published. Questions: info@bizplug.ai.
- 1Sign in: run
npx @bizplug/cli login. It shows a code and opens a link to the portal. - 2In the portal, check the code matches the one in your terminal, and press Approve. The CLI is now linked to your account.
- 3Send a business profile:
npx @bizplug/cli push my-business.json. The profile is split into the plug-in's files (business.csv, services.csv and so on), and each is checked as an upload is. The plug-in is added to your account the first time. - 4Ask for a test deploy:
npx @bizplug/cli request <industry>/<business> test, or add--requesttopush. BizPlug publishes it to the test server and emails you. - 5See where it stands:
npx @bizplug/cli status <industry>/<business>shows its files, status, release and addresses.
Commands
| Command | What it does |
|---|---|
bizplug login / logout / whoami | Link this computer to your account, unlink it (its key is revoked), or show the account |
bizplug industries | The industry plug-ins and the files each needs |
bizplug plugins | Your plug-ins with their status and addresses |
bizplug push <profile.json...> | Add or update plug-ins from business profiles; --request then asks for a test deploy |
bizplug upload <plugin> <dataset> <file.csv> | Send one file, as the upload button does |
bizplug request <plugin> test|prod | Ask BizPlug to deploy to test, or to production |
bizplug status <plugin> | Files, status, release and the addresses to add in ChatGPT |
bizplug upgrade <plugin> test|prod | Move it to the current plug-in version, as the Upgrade button does: test first, then production |
bizplug card <plugin> --theme <id>, --colors <main>,<second>,<background>, --banner <address> | How the card looks, as Card theme on the plug-in page does. none removes the colours or the banner |
bizplug assistant <plugin> --number <+E164> --code <code> | The plug-in's msg2ai WhatsApp assistant, as the msg2ai assistant tile under Integrations: the card's WhatsApp button opens that number with Join <code>. --off removes it. |
bizplug translations <plugin> [--languages ar,ko] [--download <file.csv>] [--upload <file.csv>] | The card's languages: how many texts each language covers, the languages the card offers, and your translations as a CSV to download or upload. Live with the next publish. |
bizplug translate <plugin> --languages ar,ko [--model <id>] [--upload] | Translates the card's texts with your own Anthropic API key (ANTHROPIC_API_KEY), on your computer: the texts go from your computer to Anthropic, on your Anthropic account. BizPlug never sees the key and pays for nothing. It writes a CSV for you to check; --upload also saves it. Texts that already have a translation are skipped unless you add --all. |
<plugin> is the business's key (the slug in its profile), industry/key, or the plug-in's id. One account can hold several plug-ins of the same industry, one per business, each with its own key.
The profile file
A profile is one JSON file per business, the same shape as BizPlug's own profiles: industry, slug, name, tagline, summary, email, website, logo, then what the plug-in needs, such as services, faqs, bookable and openHours. tagline is a few words shown after your name in ChatGPT, and logo an https image used as your plug-in's icon. Run bizplug industries to see which files a plug-in needs.
Signing in creates an API key for your account that only your computer holds, in your config folder (~/.config/bizplug/config.json). You can revoke it under API in the portal, or with bizplug logout. For CI, set BIZPLUG_API_KEY to a key made in the portal instead.
Publishing straight to the test server or production with bizplug publish is for BizPlug team accounts. Every other account asks for a deploy, and the BizPlug team signs off, as in the portal.
A profile may also carry how the card looks and your own forms: cardTheme (a card theme id), cardLayout (a menu layout id, such as ask, app, story or christmas) customForms (the forms built with the BizPlug Form Tool: each with key, title, when, fields and an optional done) and forms (links to your forms in other tools). bizplug push keeps them when they pass the same checks as in the portal, and says which were kept. Forms are saved as a draft and go live with the next publish.
Last reviewed 22 November 2026