Forge SDK

The Forge SDK is the JavaScript/TypeScript library that provides the APIs and tools needed to build Forge Plugins. It handles communication between your plugin and the Forge platform.

The Forge SDK is in active development. Installation details and API references will be published here as they become available. Watch for updates or contact support@getforge.com for early access.

What the SDK Will Provide

Platform APIs

• Site API: Read site configuration, metadata, versions, and deployment status
• User API: Access current user context, permissions, and organisation information
• Storage API: Persist plugin-specific data and configuration
• Events API: Subscribe to platform events (deploys, builds, form submissions)

UI Components

• Panel rendering: Render custom UI within Forge dashboard extension points
• Modal system: Open modals for confirmations, settings, and complex workflows
• Notification API: Show toasts and alerts to users from plugin actions

Development Tools

• Local development server for testing plugins against a Forge site
• CLI commands for scaffolding, building, and deploying plugins
• TypeScript type definitions for all APIs and interfaces

Expected Installation

Once released, the SDK will be available via npm:

npm install @beachio/forge-sdk

Expected Usage

import { ForgePlugin, SiteTab } from '@beachio/forge-sdk';

const plugin = new ForgePlugin({
  name: 'my-plugin',
  version: '1.0.0',
});

plugin.register(SiteTab, {
  title: 'My Custom Tab',
  icon: 'dashboard',
  render: (context) => {
    // context provides site data, user info, and SDK methods
    return <div>Hello from ${context.site.name}</div>;
  },
});

export default plugin;

The above is an illustrative example. The final API may differ.

Stay Updated

• Community forum: Forge community
• Support: support@getforge.com
• SDK reference: The full SDK Reference will be updated as the API stabilises