nocobase-dsl-reconciler

Synchronize YAML DSLs bidirectionally with live NocoBase instances.

45|10|Updated Mar 2, 2026
One-click install
npx skills add https://github.com/nocobase/skills --skill nocobase-dsl-reconciler
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: nocobase-dsl-reconciler
Source: https://github.com/nocobase/skills/tree/main/skills/nocobase-dsl-reconciler
Command: npx skills add https://github.com/nocobase/skills --skill nocobase-dsl-reconciler

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires psycopg2, and includes scripts (resource) components.

What problem does it solve?

The DSL Reconciler enables reliable, offline-first synchronization between YAML-based DSL definitions and a live NocoBase instance, empowering teams to push design intent and pull runtime state back into code for version control and auditing.

Core Features & Use Cases

  • Supports push, pull, diff, and duplicate-project workflows to manage multi-environment deployments.
  • Maintains strict UID/template bindings and performs safe rebindings when duplicating modules or exporting templates.
  • Handles complex DSL elements (pages, blocks, popups, dashboards, workflows, and recordActions) and validates changes before deployment.

Quick Start

Set up a DSL workspace under workspaces/<project>, then run the reconciler push to deploy to NB and pull to sync changes back into DSL.

Frequently Asked Questions about nocobase-dsl-reconciler

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

FAQPage Schema
How do I synchronize YAML DSL files with a live NocoBase instance?

Synchronizing YAML DSL with a live NocoBase instance involves automated bidirectional push and pull workflows, applying local definitions to the live app and pulling runtime state back into YAML code for version control.

What is DSL reconciliation for NocoBase application deployments?

DSL reconciliation is an offline-first synchronization process that aligns YAML-based design definitions with live NocoBase apps, enabling reliable version control and auditing for complex multi-environment deployments.

How do I manage version control for NocoBase pages, blocks, and workflows?

Version control for NocoBase pages, blocks, and workflows is managed by pulling complex app elements into YAML DSL files, validating changes locally, and pushing updated definitions back to the live instance.

Can I duplicate NocoBase modules while preserving UID and template bindings?

Yes, duplicating NocoBase modules preserves strict UID and template bindings by performing safe rebindings during export, ensuring that defaults.yaml bindings and state.yaml mappings remain intact across the duplicated project.

Does the NocoBase YAML reconciler require a specific database driver?

Yes, the NocoBase YAML reconciler requires the psycopg2 driver as a dependency to establish the database connection needed for applying DSL changes and pulling runtime state back into your local workspace.

What are the limitations of offline-first DSL synchronization for NocoBase?

Offline-first DSL synchronization enforces local validation before deployment and requires maintaining strict UID mappings, meaning any structural drift or unhandled complex DSL elements like popups and dashboards must be manually reconciled.