sugar-new-module

Generate complete SugarCRM modules with bean classes, metadata, views, and dashboards.

6|3|Updated Oct 27, 2025
One-click install
npx skills add https://github.com/sugarcrm-developers/ai-for-sugar-devs --skill sugar-new-module
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sugar-new-module
Source: https://github.com/sugarcrm-developers/ai-for-sugar-devs/tree/main/skills/sugar-new-module
Command: npx skills add https://github.com/sugarcrm-developers/ai-for-sugar-devs --skill sugar-new-module

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires SugarCRM, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill helps Sugar developers create a complete SugarCRM module from scratch, following the Module Builder (MB) style without relying on the MB UI.

Core Features & Use Cases

  • Create Full MB-style Modules: Automatically generates 22 files including a bean class, sugar parent, vardefs, metadata, Sidecar views, and dashboards.
  • Enforces Escalation Pattern: Ensures consistency by following the 'Escalation singular/plural' pattern used in MB-style modules.
  • Use Case: If you need a custom module for your Sugar instance, use this Skill to rapidly develop it, even for those new to MB-style development.

Quick Start

Generate a new module called 'Foos' by running the sugar-new-module skill with the module name as the parameter.

Frequently Asked Questions about sugar-new-module

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

FAQPage Schema
How do I generate a SugarCRM module from scratch without using Module Builder?

To generate a SugarCRM module from scratch, you can use a Python script to automatically populate a complete MB-style structure including bean classes, metadata, views, filters, menus, and dashboards without relying on the MB UI.

What files are included when creating an MB-style SugarCRM module programmatically?

Creating an MB-style SugarCRM module programmatically generates 22 files, including a bean class, sugar parent, vardefs, metadata, Sidecar views, and dashboards to ensure a fully functional module structure.

Do I need to know the Escalation naming convention to build SugarCRM custom modules?

Yes, knowing the Escalation naming convention is necessary. The module generation enforces the Escalation singular/plural pattern used in MB-style modules to ensure consistency across your SugarCRM custom modules.

What is the best way to extend existing SugarCRM functionality with a custom module?

The best way to extend existing SugarCRM functionality is by developing a complete custom module using a Python script that constructs the MB-style architecture, suitable for both new modules and extending current features.

Can I use this approach to build a SugarCRM module if I am new to MB-style development?

Yes, you can rapidly develop a custom SugarCRM module even if you are new to MB-style development, as the script automatically handles the complex population of the required module files and structure.