rails-engine-author

Create Rails engine skeletons with host-app contracts and standardized structure.

22|6|Updated Mar 11, 2026
One-click install
npx skills add https://github.com/igmarin/rails-agent-skills --skill rails-engine-author
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rails-engine-author
Source: https://github.com/igmarin/rails-agent-skills/tree/main/rails-engine-author
Command: npx skills add https://github.com/igmarin/rails-agent-skills --skill rails-engine-author

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Scaffolding, maintaining, and refactoring Rails engines is error-prone without a consistent blueprint. This skill provides a standardized structure, host-app contract guidance, and best-practice conventions to streamline engine development.

Core Features & Use Cases

  • Clear engine layout templates (lib/, app/, config, and a dummy host app) to accelerate bootstrapping.
  • Host-app contract documentation and integration guidelines to ensure predictable host interactions.
  • Guidance on selecting engine type (Plain gem, Railtie, Engine, Mountable engine) with recommended defaults.

Quick Start

Create a minimal Rails engine scaffold that includes a host-app contract, recommended file layout, and a starter structure.

Frequently Asked Questions about rails-engine-author

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

FAQPage Schema
How do I scaffold a Rails engine with a standardized structure?

A mountable Rails engine isolates its routes and assets, whereas a regular engine shares them with the host app. This skill guides you in selecting the appropriate engine type based on your host-app integration requirements.

What is a host-app contract in Rails engine development?

A host-app contract in Rails engine development defines the predictable interactions and boundaries between the engine and the host application. This skill provides documentation guidelines to ensure those integration points remain explicit and stable.

When do I need to refactor a plain gem into a Railtie or mountable engine?

You do not need additional dependencies to create Rails engine skeletons with this skill. It operates without external dependencies, providing self-contained conventions for engine layout, testing, and documentation.

What is the best way to document host-app contracts for Rails engines?

The best way to document host-app contracts for Rails engines is to maintain explicit integration guidelines within the engine structure. This skill provides standardized conventions to ensure predictable host interactions and clear separation of concerns.