Phials plugin documentation

Build plugins that add focused capabilities to Phials, from commands and file views to editors, panels, metadata, and themes. The public SDK gives your plugin typed registration contracts, runtime services, validation tools, and generated API reference.

Start with the plugin starter if you are building your first plugin. If you already have a project, go directly to the capability or workflow you need.

• Get started explains the plugin model, walks through a first working plugin, and introduces Svelte 5 and Phoundry UI.
• Add capabilities covers commands, file viewing and editing, metadata, file views, panels and tabs, settings, and themes.
• Work with Phials covers files, Explorer context, durable data, events, dialogs, and notifications.
• Test and troubleshoot establishes a repeatable local workflow, validation strategy, and symptom-driven recovery path.
• Package and publish covers manifests, release artifacts, the community registry, and ongoing maintenance.
• Reference defines compatibility, lifecycle, permissions, events, and the generated public SDK surface.

Community plugins run as trusted JavaScript in the Phials renderer. Permissions gate supported Plugin API operations, but they are not a JavaScript sandbox. Review the community plugin trust model before you publish a plugin that handles sensitive files or data.