@webmaxru/enonic-api-reference
Enonic XP server-side JavaScript/TypeScript API reference for all /lib/xp/* libraries. Provides function signatures, parameters, return types, and usage examples for lib-content, lib-node, lib-auth, lib-portal, lib-context, lib-event, lib-task, lib-repo, lib-io, lib-mail, and lib-schema. Use when looking up Enonic XP library functions, parameter shapes, return types, or usage examples. Do not use for Guillotine GraphQL queries, content type schema definitions, Enonic CLI commands, or non-Enonic JavaScript APIs.
Enonic XP Agent Skills
<p align="center">
<img src="assets/repo-banner.svg" alt="Enonic XP Agent Skills" width="100%" />
</p>
A maintained collection of agent skills for Enonic XP 7 development. These skills cover the core Enonic XP development surface: server-side APIs, content modeling, content migration, Guillotine GraphQL queries, Next.js headless integration, controller generation, webhook/event integrations, and local development environment management.
The repository follows the agentskills.io style: lean SKILL.md files, progressive disclosure through references/ and assets/, and deterministic helper scripts where guessing would be brittle.
Disclaimer: This project is not affiliated with, endorsed by, or officially connected to Enonic in any way. It is an independent community effort.
Contents
Install
Install via Plugin Marketplace (recommended)
The easiest way to get all Enonic XP skills is through the webmaxru/ai-native-dev plugin marketplace. Add the marketplace, then install the enonic-skills plugin from it.
GitHub Copilot CLI
> /plugin marketplace add webmaxru/ai-native-dev
> /plugin install enonic-skills@webmaxru-ai-native-dev
VS Code (GitHub Copilot)
Run Chat: Install Plugin From Source from the Command Palette and enter:
https://github.com/webmaxru/ai-native-dev
Or add to your settings.json:
"chat.plugins.marketplaces": [
"webmaxru/ai-native-dev"
]
Then open the Extensions sidebar, search @agentPlugins enonic-skills, and click Install.
Claude Code
> /plugin marketplace add webmaxru/ai-native-dev
> /plugin install enonic-skills@webmaxru-ai-native-dev
After installation, your coding agent has access to all Enonic XP skills — no per-skill setup required.
Install Individual Skills
If you prefer to install specific skills rather than the full marketplace, use Agent Package Manager (APM) or the skills npm package.
APM
apm init # if the target repo does not already use APM
apm install webmaxru/enonic-agent-skills/skills/SKILL_NAME
npm
npx skills add webmaxru/enonic-agent-skills --skill SKILL_NAME
The concrete install commands for each available skill are listed in the relevant skill sections below.
Skills in This Repository
Enonic Library Reference Skill
skills/enonic-library-reference provides a server-side JavaScript/TypeScript API reference for all /lib/xp/* libraries. It covers function signatures, parameters, return types, and usage examples for lib-content, lib-node, lib-auth, lib-portal, lib-context, lib-event, lib-task, lib-repo, lib-io, lib-mail, lib-schema, lib-project, lib-export, lib-scheduler, lib-value, lib-i18n, lib-websocket, lib-admin, lib-app, lib-auditlog, lib-cluster, lib-common, lib-grid, and lib-vhost.
Install with APM:
apm install webmaxru/enonic-agent-skills/skills/enonic-library-reference
Install with npm:
npx skills add webmaxru/enonic-agent-skills --skill enonic-library-reference
It covers:
- looking up Enonic XP library functions, parameter shapes, and return types
- mapping queries to the correct reference file for each
/lib/xp/*library - composing cross-library usage patterns (e.g., creating content as admin)
- generating reusable import blocks from the provided template
- troubleshooting common API errors and version mismatches
Its support files are split by purpose:
references/lib-content-reference.mdfor lib-content function signatures and usagereferences/lib-node-reference.mdfor lib-node function signatures and usagereferences/lib-auth-reference.mdfor lib-auth function signatures and usagereferences/lib-portal-reference.mdfor lib-portal function signatures and usagereferences/lib-context-reference.mdfor lib-context, lib-event, and lib-task functionsreferences/lib-utilities-reference.mdfor lib-io, lib-mail, lib-repo, and lib-schema functionsreferences/lib-cms-reference.mdfor lib-project, lib-export, lib-scheduler, and lib-value functionsreferences/lib-web-reference.mdfor lib-i18n and lib-websocket functionsreferences/lib-platform-reference.mdfor lib-admin, lib-app, lib-auditlog, lib-cluster, lib-common, lib-grid, and lib-vhost functionsreferences/examples.mdfor cross-library usage patternsreferences/troubleshooting.mdfor common errors and version-compatibility notesassets/enonic-imports.template.tsfor a reusable import block template
Enonic Content Management Skill
skills/enonic-content-management generates Enonic XP scripts for bulk content operations — creating, updating, querying, migrating, and transforming content using lib-content and lib-node APIs.
Install with APM:
apm install webmaxru/enonic-agent-skills/skills/enonic-content-management
Install with npm:
npx skills add webmaxru/enonic-agent-skills --skill enonic-content-management
It covers:
- bulk content creation, update, and deletion scripts
- querying with NoQL syntax, aggregations, and paginated retrieval
- migrating content between environments using branch operations
- wrapping long-running operations in task controllers with progress reporting
- batch processing with configurable batch sizes and error tracking
Its support files are split by purpose:
references/migration-reference.mdfor query DSL patterns, batch processing strategies, and branch handling rulesreferences/examples.mdfor complete query and aggregation patternsreferences/compatibility.mdfor version-specific API differencesreferences/troubleshooting.mdfor duplicate handling, timeout, and permission issuesassets/bulk-update.template.tsfor a reusable batch update controller templateassets/task-migration.template.tsfor a reusable task controller template with progress reportingscripts/find-enonic-targets.mjsfor deterministic scanning of Enonic XP project markers
Enonic Content Type Generator Skill
skills/enonic-content-type-generator generates Enonic XP content type XML schema definitions from natural-language descriptions. It covers structured content modeling including input types, form layout, option sets, item sets, mixins, x-data, and content-type inheritance.
Install with APM:
apm install webmaxru/enonic-agent-skills/skills/enonic-content-type-generator
Install with npm:
npx skills add webmaxru/enonic-agent-skills --skill enonic-content-type-generator
It covers:
- creating content type XML schemas from natural-language field descriptions
- mapping field descriptions to correct Enonic XP input types and configurations
- generating mixins, x-data, item sets, and option sets
- validating output XML for well-formedness and correct input type usage
- scaffolding the correct directory structure under
site/content-types/
Its support files are split by purpose:
references/content-type-reference.mdfor input types, super-types, and schema structurereferences/examples.mdfor complete content type definition patternsreferences/troubleshooting.mdfor XML validation errors and input type mismatchesassets/content-type.template.xmlfor a starter content type templatescripts/find-enonic-targets.mjsfor deterministic scanning of Enonic XP project markers
Enonic Guillotine Query Builder Skill
skills/enonic-guillotine-query-builder composes, debugs, and optimizes Guillotine GraphQL queries for Enonic XP headless content delivery.
Install with APM:
apm install webmaxru/enonic-agent-skills/skills/enonic-guillotine-query-builder
Install with npm:
npx skills add webmaxru/enonic-agent-skills --skill enonic-guillotine-query-builder
It covers:
- constructing GraphQL queries using Query DSL input types
- building content type fragments with inline fragment type-name deriving
- filtering, sorting, pagination, aggregations, and highlighting
- migrating from deprecated 5.x string-based queries to 6.x+ DSL syntax
- generating TypeScript types from Guillotine query responses
Its support files are split by purpose:
references/guillotine-reference.mdfor the Guillotine API surface and query patternsreferences/examples.mdfor complete query construction patternsreferences/compatibility.mdfor version migration and breaking changesreferences/troubleshooting.mdfor null results, type errors, and deprecated API usageassets/guillotine-query.template.tsfor a reusable typed query templatescripts/find-guillotine-targets.mjsfor deterministic scanning of Guillotine markers in the workspace
Enonic Next.XP Integration Skill
skills/enonic-nextxp-integration guides setup, development, and troubleshooting of the Next.js and Enonic XP headless integration (Next.XP framework).
Install with APM:
apm install webmaxru/enonic-agent-skills/skills/enonic-nextxp-integration
Install with npm:
npx skills add webmaxru/enonic-agent-skills --skill enonic-nextxp-integration
It covers:
- configuring the
@enonic/nextjs-adapterpackage and environment variables - mapping Enonic content types to React components via
ComponentRegistry - wiring Guillotine GraphQL data fetching in Next.js with typed queries
- enabling Content Studio preview mode with draft/master branch switching
- deploying Enonic + Next.js to production (Enonic Cloud + Vercel)
Its support files are split by purpose:
references/nextxp-reference.mdfor adapter configuration, component registry API, and deployment checklistreferences/examples.mdfor complete content type mapping examples including queries, views, and processorsreferences/compatibility.mdfor version requirements between the adapter, Next.js, and Enonic XPreferences/troubleshooting.mdfor preview failures, blank pages, and configuration issuesassets/nextxp-page.template.tsxfor a reusable page component template
Enonic App Manager Skill
skills/enonic-app-manager guides developers through Enonic CLI commands for sandbox management, project scaffolding, local development, app deployment, and CI/CD pipeline generation.
Install with APM:
apm install webmaxru/enonic-agent-skills/skills/enonic-app-manager
Install with npm:
npx skills add webmaxru/enonic-agent-skills --skill enonic-app-manager
It covers:
- creating, starting, stopping, upgrading, and deleting Enonic XP sandboxes
- scaffolding new projects from starters (
starter-vanilla,starter-headless,starter-nextjs) - running dev mode with hot-reload, building, deploying, and testing Enonic apps
- managing applications on running XP instances
- generating GitHub Actions CI/CD workflows for Enonic projects
Its support files are split by purpose:
references/cli-reference.mdfor the full Enonic CLI command catalogreferences/examples.mdfor common CLI workflow patternsreferences/compatibility.mdfor CLI-to-XP version compatibilityreferences/troubleshooting.mdfor sandbox startup failures, port conflicts, and deployment issuesassets/enonic-ci.template.ymlfor a GitHub Actions CI/CD workflow templateassets/sandbox-setup.template.shfor a sandbox setup script templatescripts/find-enonic-targets.mjsfor deterministic scanning of Enonic XP project markers
Enonic Event Manager Skill
skills/enonic-event-manager sets up Enonic XP event listeners, webhook configurations, and external system integrations triggered by content lifecycle events.
Install with APM:
apm install webmaxru/enonic-agent-skills/skills/enonic-event-manager
Install with npm:
npx skills add webmaxru/enonic-agent-skills --skill enonic-event-manager
It covers:
- registering event listeners for content publish, create, update, and delete events
- configuring outbound webhooks via
com.enonic.xp.webhooks.cfg - building HTTP service controllers for inbound webhook endpoints
- wiring async processing with lib-task for heavy or long-running event handlers
- calling external systems with lib-httpClient from event callbacks
Its support files are split by purpose:
references/event-reference.mdfor event types, listener patterns, and task event lifecyclereferences/webhook-reference.mdfor outbound webhook configuration and inbound service endpointsreferences/examples.mdfor CDN invalidation, search reindexing, and notification patternsreferences/troubleshooting.mdfor event non-firing, webhook delivery failures, and 404 service errorsassets/event-listener.template.tsfor a reusable event listener scaffoldassets/http-service.template.tsfor a reusable inbound webhook service scaffoldscripts/find-enonic-targets.mjsfor deterministic scanning of Enonic XP project markers
Enonic Controller Generator Skill
skills/enonic-controller-generator generates Enonic XP controller files (TypeScript/JavaScript) and paired XML descriptors for pages, parts, and layouts.
Install with APM:
apm install webmaxru/enonic-agent-skills/skills/enonic-controller-generator
Install with npm:
npx skills add webmaxru/enonic-agent-skills --skill enonic-controller-generator
It covers:
- scaffolding page controllers with regions, part controllers with config access, and layout controllers with multi-region support
- generating paired XML descriptors with display names, forms, and region definitions
- generating Thymeleaf or Mustache view templates with proper region wiring
- creating response processors for site-level HTTP response modification
- updating
build.gradlewith required library dependencies
Its support files are split by purpose:
references/controller-reference.mdfor XML descriptor schema and Portal API surfacereferences/examples.mdfor known-good controller patternsreferences/compatibility.mdfor TypeScript vs JavaScript differencesreferences/troubleshooting.mdfor descriptor mismatches and rendering issuesassets/page-controller.template.tsfor a reusable page controller templateassets/part-controller.template.tsfor a reusable part controller templateassets/layout-controller.template.tsfor a reusable layout controller templatescripts/find-enonic-targets.mjsfor deterministic scanning of Enonic XP project markers
Repository Conventions
When adding or revising a skill here, keep these rules intact:
- The skill directory name must match the YAML
nameexactly. - Skill descriptions should be precise enough to route correctly and include both positive and negative triggers.
SKILL.mdshould stay lean, procedural, and agent-oriented.- Large examples, verbose rules, and schemas belong in
references/orassets/. - File paths inside skills should stay relative and use forward slashes.
- Skill folders should remain flat under
scripts/,references/, andassets/. - Human-oriented files such as per-skill
README.mdorCHANGELOG.mdshould not be added inside skill directories.
Common Workflows
Scan a Workspace for Enonic XP Targets
node skills/enonic-content-management/scripts/find-enonic-targets.mjs .
The scanner locates Enonic XP project markers: build.gradle with com.enonic.xp dependencies, src/main/resources/ directory structure, and gradle.properties with xpVersion.
Scan a Workspace for Guillotine Targets
node skills/enonic-guillotine-query-builder/scripts/find-guillotine-targets.mjs .
The scanner inventories files containing Guillotine markers such as query strings, library imports, queryDsl, queryDslConnection, and /lib/guillotine references.
References
- Enonic XP documentation: https://developer.enonic.com/docs
- agentskills.io best practices: https://platform.claude.com/docs/en/agents-and-tools/agent-skills/best-practices
Loading...
Select a file to preview
Analyzing security...
Checking scan reports and verification data.
Bill of Materials
Everything this skill can do — files, network, commands, and more.