Build integrations for PlotPickle without importing application internals.
API status: The Phase 9 SDK and plugin APIs are preview APIs until RC4 freezes the project, plugin and file-format contracts. Public packages are not yet published to a registry; repository workspace imports are used during development.
- Getting started
- Plugin manifest reference
- SDK and Core Services API
- Permissions and security
- Events and interface extensions
- Importers, exporters and providers
- Testing, compatibility and troubleshooting
- Example plugin catalog
| Area | Use it for |
|---|---|
| Getting started | Creating, validating and testing a first plugin |
| Manifest | Declaring compatibility, capabilities and permissions |
| API reference | Activation lifecycle, services, events, registrations and testing exports |
| Security | Least-privilege access, credentials, approvals and provenance |
| Extensions | Commands, menus, panels, workspaces and typed events |
| Integrations | AI, local models, GitHub, FDX, Fountain, PDF, images and music |
| Compatibility | Version negotiation, migration and error recovery |
- Stable: documented project exchange concepts already covered by frozen schemas.
- Preview:
@plotpickle/sdk,@plotpickle/plugin-sdk, plugin API version1.0.0, events and extension registrations. These are supported for current development but may receive documented migration changes before RC4. - Internal: application components, stores, routes and implementation modules not exported by public packages. Plugins must never import these.
This entire folder is the canonical offline documentation bundle. Markdown links are relative so the bundle works from a cloned or downloaded repository without a network connection.
Run documentation validation with:
npm run test:developer-docsThe command checks required pages, navigation links, API coverage markers and the search index used by a future hosted portal.