A basic example of Beekeeper Studio plugin demonstrating form creation, data persistence, and cross-view communication.

• Submit user ratings from Tools > New Form
• View the data from Tools > View Summary

• Beekeeper Studio >= 5.4
• Node.js >= 20.19

1. Clone the repository

   git clone https://github.com/beekeeper-studio/bks-sample-plugin
   cd bks-sample-plugin

2. Install dependencies

   yarn install

3. Create a symbolic link to the plugin directory

   The symlink name must match the id field in manifest.json. For example, bks-sample-plugin.

   Linux:

   ln -s $(pwd) ~/.config/beekeeper-studio/plugins/bks-sample-plugin

   macOS:

   ln -s $(pwd) "~/Library/Application Support/beekeeper-studio/plugins/bks-sample-plugin"

   Windows:

   mklink /D "%APPDATA%\beekeeper-studio\plugins\bks-sample-plugin" "%CD%"

   Windows (Portable version):

   mklink /D "/path/to/beekeeper-studio/beekeeper-studio-data/plugins/bks-sample-plugin" "%CD%"

4. Start development server

   yarn dev

5. For production build

   yarn build

This repository contains Github Actions workflow that automates the release process by pushing a tag prefixed with v:

1. Push a version tag

   git tag v1.0.0
   git push origin v1.0.0

2. Once the GitHub Action completes, go to your repository's Releases page

3. Find the release

4. Mark it as "Latest release"

If you don't have the GitHub Actions workflow set up:

1. Build the plugin

   yarn build

2. Create the plugin archive

   The name format is <pluginId>-<version>.zip

   zip -r bks-sample-plugin-1.0.0.zip dist/

3. Go to your repository on GitHub

4. Click "Releases" → "Create a new release"

5. Tag the release with the version, for example, v1.0.0 (prefixed with v)

6. For assets, attach the current manifest.json and the zip file

7. Fill the title and description

8. Click "Publish release"

To make your plugin discoverable in Beekeeper Studio's plugin manager:

1. Fork the plugins registry at beekeeper-studio/beekeeper-studio-plugins

2. Add your plugin to plugins.json

   {
     "id": "bks-sample-plugin",
     "name": "Sample Plugin",
     "author": "Your Name",
     "description": "A sample plugin demonstrating form creation, data persistence, and cross-view communication in Beekeeper Studio",
     "repo": "yourusername/bks-sample-plugin"
   }

3. Submit a pull request to beekeeper-studio/beekeeper-studio-plugins

4. Once approved & merged by our team, your plugin will be available in Beekeeper Studio for public

• Documentation: Visit the Plugin Development Guide
• Community Slack: Join the Beekeeper Studio Community
• Issues: Report bugs or request features in the main repository

MIT