Wheels Plugin Generator

Generate CFWheels plugin scaffolds with ForgeBox packaging metadata.

203|108|Updated Jan 13, 2011
One-click install
npx skills add https://github.com/wheels-dev/wheels --skill wheels-plugin-generator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Wheels Plugin Generator
Source: https://github.com/wheels-dev/wheels/tree/main/.claude/skills/wheels-plugin-generator
Command: npx skills add https://github.com/wheels-dev/wheels --skill wheels-plugin-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill guides developers in creating well-structured, reusable CFWheels plugins, ensuring they follow Wheels conventions and can be easily shared and managed via ForgeBox. It automates the setup, so you can focus on the plugin's core functionality.

Core Features & Use Cases

  • Standardized Plugin Structure: Generates the complete plugin directory structure, including index.cfm, box.json, README.md, and optional config/, controllers/, models/, views/, events/, db/, and tests/ directories.
  • ForgeBox Integration: Provides a box.json template and guidance for publishing your plugin to ForgeBox, making it discoverable and installable.
  • Event Handling & Mixins: Shows how to register event handlers and add global, model, controller, or view helper methods using mixins.
  • Use Case: Develop a custom authentication plugin for Wheels. This skill provides the boilerplate for the plugin's structure, configuration, and even how to publish it to ForgeBox, saving you significant setup time and ensuring your plugin is professional and shareable.

Quick Start

Plugin directory structure:

/plugins/YourPlugin/ ├── index.cfm ├── box.json └── config/ └── settings.cfm

Frequently Asked Questions about Wheels Plugin Generator

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

FAQPage Schema
How do I create a CFWheels plugin with the correct directory structure?

Creating a CFWheels plugin generates a complete scaffold with index.cfm, box.json, and optional config/, controllers/, models/, views/, events/, db/, and tests/ directories following Wheels conventions. This standardized structure ensures your plugin is organized, maintainable, and ready for distribution.

Can I publish a Wheels plugin to ForgeBox?

Yes. The plugin generator includes a box.json template configured for ForgeBox integration, enabling you to publish your plugin as a discoverable, installable package. This automates the metadata setup so your plugin can be easily shared with the Wheels community.

How do I add event handlers and mixins to a Wheels plugin?

The plugin scaffold provides entry points and examples for registering event handlers and global, model, controller, or view helper methods using mixins. This lets you extend Wheels functionality and inject reusable logic across your application.

What does a Wheels plugin entry point do?

A plugin entry point (index.cfm) is the initialization file that loads your plugin's configuration, registers events, and applies mixins when the plugin is loaded. It serves as the single control point for your plugin's activation within a Wheels application.

Do I need to manually write all the boilerplate for a new Wheels plugin?

No. The plugin generator automates boilerplate creation, including directory layout, configuration files, event handling templates, test structure, and documentation stubs. This lets you focus on your plugin's core functionality instead of setup.

Can I use this plugin generator for packaging reusable components?

Yes. The generator is designed for packaging reusable Wheels components with ForgeBox metadata, making it ideal for creating distributable plugins that extend Wheels functionality or add domain-specific features for broader use.