orchardcore-recipe-creator

Creates OrchardCore setup recipes that provision tenants with features, themes, content types, and content.

8.2k|2.6k|Updated Nov 19, 2014
One-click install
npx skills add https://github.com/OrchardCMS/OrchardCore --skill orchardcore-recipe-creator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: orchardcore-recipe-creator
Source: https://github.com/OrchardCMS/OrchardCore/tree/main/.agents/skills/orchardcore-recipe-creator
Command: npx skills add https://github.com/OrchardCMS/OrchardCore --skill orchardcore-recipe-creator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Manually configuring a new OrchardCore tenant—enabling modules, setting themes, defining content types, importing content, and assigning roles—is repetitive and error-prone. This Skill guides you through authoring a .recipe.json setup recipe that automates the entire tenant provisioning process.

Core Features & Use Cases

  • Setup Recipe Authoring: Produces a complete .recipe.json with header metadata, variables, and ordered steps that appears in the tenant setup screen via issetuprecipe: true.
  • Full Step Catalog: Covers every built-in recipe step including feature, themes, settings, Roles, ContentDefinition, content, media, layers, queries, Templates, AdminMenu, WorkflowType, deployment, and search index steps.
  • Dynamic Values: Uses recipe helpers like [js:uuid()], [file:text(...)], [env:...], and [appsettings:...] for generated ids, external files, and configuration values.
  • Use Case: You are building a new OrchardCore theme and want new tenants to be fully provisioned on setup. The Skill generates a recipe that enables your theme's features, sets it as the site theme, defines an Article content type, and imports a homepage content item.

Quick Start

Ask the assistant to create an OrchardCore setup recipe for your theme that enables the core content features, sets the site and admin themes, and imports a homepage content item.

Frequently Asked Questions about orchardcore-recipe-creator

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

FAQPage Schema
How do I create an OrchardCore setup recipe?

Create a file ending in .recipe.json inside a Recipes folder of any module or theme, with a header containing name, displayName, and issetuprecipe set to true, plus an ordered steps array. The recipe then appears in the setup screen's recipe dropdown when creating a tenant.

What steps can an OrchardCore recipe include?

Built-in steps include feature, themes, settings, Roles, ContentDefinition, content, media, layers, queries, Templates, AdminMenu, WorkflowType, deployment, custom-settings, recipes, and search index steps for Lucene, Elasticsearch, and Azure AI Search. Steps execute top to bottom in the order listed.

Why is my OrchardCore theme not rendering after setup?

The theme's feature was likely not enabled in the recipe's feature step before being set as the site theme in the themes step. Always enable your own theme's feature id in the feature step, otherwise the layout will not render after setup completes.

How do I share a generated content item id between recipe steps?

Define a variable in the recipe header such as "homeContentItemId": "[js:uuid()]", then reference it in later steps with "[js:variables('homeContentItemId')]". Variables are evaluated once on first access and reused across all steps.

Can OrchardCore recipes run outside the setup screen?

Yes, recipes without issetuprecipe set to true can be executed from the admin under Configuration, then Recipes, then Run. Recipes can also run as data migrations from a Migrations folder via IRecipeMigrator in a DataMigration class.