Plugin Guide

BBPlugin DevelopmentIncluded with bb
Get it for macOS

Browse the bb plugin API as an annotated map of the product.


Overview

View source

Find out where a plugin can add to bb before you write one. The Plugin Guide is a page in the sidebar that shows the bb product as a set of annotated wireframes.

What you get

  • Seven maps. They cover the app window, the command palette, the composer, and the home page. They also cover plugin settings, the Plugins page, and the plugin backend.
  • A numbered card for each surface with a summary and the SDK symbols to use.
  • A list of first-party plugins that use each surface. Each name links to the plugin page when that plugin is installed or in the catalog.
  • A URL for each map, so you can link to one and use the back and forward buttons.

How it works

Open Plugin Guide from the sidebar, or read the public copy at getbb.app/plugin-guide without installing bb. Click a number on the wireframe to read its card. Each card names the exact types and methods from @get-bb/plugin-sdk so you can search for them in your editor.

For agents

Each card has a Copy for agent action. It copies a mention that you paste into the composer. When you send the message, the agent receives the full description of that surface and its SDK symbols. You can also type the mention directly with @ and the surface title.

More from BB

More in Plugin Development 4

Understand, inspect, build, or debug bb and its plugin surfaces.

View all