halo-plugin-dev

Scaffold Halo CMS plugins with Java, Vue, and YAML manifests.

9|Updated Mar 26, 2026
One-click install
npx skills add https://github.com/halo-dev/dev-skills --skill halo-plugin-dev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: halo-plugin-dev
Source: https://github.com/halo-dev/dev-skills/tree/main/skills/halo-plugin-dev
Command: npx skills add https://github.com/halo-dev/dev-skills --skill halo-plugin-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Halo plugin development is complex due to the need to coordinate backend Java, frontend Vue, manifest configuration, and lifecycle hooks. This Skill provides a structured, end-to-end guide to streamline building Halo CMS plugins.

Core Features & Use Cases

  • Step-by-step scaffolding for backend and frontend integration, including plugin.yaml manifests, extensions, and lifecycle management.
  • Guidance on creating and registering extensions (GVK), RBAC templates, and UI integration with Console/UC.
  • Practical workflows for testing locally, validating references, and aligning with Halo's plugin framework.

Quick Start

Follow the Quick Start to scaffold a new Halo plugin project and run it in a local dev environment.

Frequently Asked Questions about halo-plugin-dev

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I develop a Halo plugin with backend Java and frontend Vue?

To develop a Halo plugin, you scaffold backend Java code and frontend Vue components, then connect them using YAML manifests like plugin.yaml. This provides an end-to-end structure for building and updating Halo CMS plugins.

How do I create and register custom extensions in a Halo plugin?

Creating custom extensions in a Halo plugin involves defining the GVK (Group, Version, Kind) structures. The plugin framework handles registration, allowing you to manage custom data models and apply RBAC templates for access control.

What is the best way to integrate a custom UI into the Halo Console?

The best way to integrate a custom UI into the Halo Console is by building Vue frontend components that interact with the backend through an OpenAPI-backed UI client, ensuring alignment with Halo's project-structure conventions.

Do I need to configure RBAC templates when building a Halo CMS plugin?

Yes, configuring RBAC templates is required when building a Halo CMS plugin if your plugin introduces custom resources or APIs. Defining these templates ensures proper role-based access control for your extensions.

How do I manage lifecycle hooks for a Halo plugin?

Managing lifecycle hooks for a Halo plugin requires implementing specific logic within the backend Java code that responds to the plugin's start, stop, and installation events defined by the Halo plugin framework.

What should be included in the plugin.yaml manifest for a Halo plugin?

The plugin.yaml manifest for a Halo plugin must include metadata, extension definitions, and references to backend and frontend assets. This configuration ensures the plugin framework correctly loads and executes your components.