Plugins

Plugins extend the local runtime used by the VS Code extension. They can subscribe to runtime events, add tools, register authentication flows, or customize model-provider behavior.

Configure a plugin

Add a local file or npm package to the plugin array in your global or project biggi.jsonc:

{
  "$schema": "https://app.biggi.dev/config.json",
  "plugin": ["./plugins/example.ts", "@example/biggi-plugin"]
}

Local paths are resolved relative to the config file. Restart the extension after changing plugin configuration.

Minimal plugin

import type { Plugin } from "@biggi/plugin"

export const Example: Plugin = async () => ({
  event: async ({ event }) => {
    console.log(event.type)
  },
})

Keep credentials outside plugin source. Read secrets from environment variables or the supported authentication APIs, and avoid logging prompts, tokens, or workspace contents.

Troubleshooting

  • Confirm the plugin path or package name is correct.
  • Confirm npm packages expose a server-compatible entry point.
  • Check the BIGGI output channel in VS Code for load errors.
  • Restart the extension after installing or updating a plugin.