Skip to content

README.md

Latest commit

 

History

History
159 lines (114 loc) · 5.31 KB

README.md

File metadata and controls

159 lines (114 loc) · 5.31 KB

WormScript AI Skills

Expert AI skills for WormScript (WRM) — the .NET code scaffolding tool that generates complete APIs, Dapper repositories, and React components from your PostgreSQL schema.

These skills give AI assistants deep knowledge of WRM conventions, annotations, features, and patterns so they can help you design schemas and build projects correctly, first time.

WRM Version: 3.3.5-WIP (3.3.4 released)
Supports: Claude Code, Cursor, GitHub Copilot, Windsurf, and any tool that accepts a custom system prompt.

Skills included

wrm-tool

WRM project and build assistant. Use when you want to:

  • Create a new WRM project and initialise it with wrm init
  • Write or edit a .wrm build script
  • Choose WRM features, configure ports, set up Docker
  • Generate models, APIs, and web components with wrm build
  • Deploy to Azure Container Apps or Azure Functions
  • Use STAGE to re-run one part of the build

SQL schema design is not this skill's responsibility — use wrm-data-builder for that.

wrm-data-builder

PostgreSQL schema designer for WRM. Use when you want to:

  • Design a database schema that's compatible with WRM annotations
  • Convert an existing schema to WRM conventions
  • Add new tables to an existing WRM project
  • Understand which WRM features fit your data requirements
  • Get annotated SQL with correct COMMENT ON statements, LIKE base.* clauses, and a ready-to-paste .wrm snippet

The two skills work together: wrm-data-builder designs the SQL → wrm-tool wraps it in a .wrm build script and runs the build.

Quick install

Install all skills for Claude Code

macOS / Linux:

git clone https://github.com/Alearian/WormScript-Skills.git
cd WormScript-Skills
bash install.sh

Windows (PowerShell):

git clone https://github.com/Alearian/WormScript-Skills.git
cd WormScript-Skills
.\install.ps1

Restart Claude Code. Skills load automatically.

Install for other tools

Run from inside the cloned repo, from your project directory:

Tool macOS/Linux Windows
Cursor bash install.sh --tool cursor .\install.ps1 -Tool cursor
GitHub Copilot bash install.sh --tool copilot .\install.ps1 -Tool copilot
Windsurf bash install.sh --tool windsurf .\install.ps1 -Tool windsurf
All tools bash install.sh --tool all .\install.ps1 -Tool all

Install a specific skill only

bash install.sh --skill wrm-data-builder               # macOS/Linux
.\install.ps1 -Skill wrm-data-builder                  # Windows

bash install.sh --skill wrm-tool --tool cursor         # wrm-tool for Cursor only
.\install.ps1 -Skill wrm-tool -Tool cursor

Any other tool (Zed, Aider, Continue, custom system prompt)

Copy the contents of {skill-name}/adapters/generic.md into your tool's system prompt or custom instructions field.

Using the skills

Claude Code

Trigger by name or naturally:

/wrm-data-builder

"Design a schema for a property management system" "I need tables for a helpdesk app — users can raise tickets, agents respond" "Add a subscription tier system to my WRM project"

/wrm-tool

"Create a new WRM project called RevCamp with AUTH and FILEHANDLING" "Update my .wrm script to add GraphQL support" "Why isn't my wrm build finding my models?" "Deploy my project to Azure Container Apps"

Other tools

Once the adapter is installed, ask naturally — the AI will apply WRM rules automatically when it detects SQL, .wrm scripts, or WRM-related questions.

Repo structure

README.md                           This file
install.sh                          macOS/Linux installer
install.ps1                         Windows installer

wrm-tool/
  SKILL.md                          Claude Code skill
  COMMAND_REFERENCE.md              .wrm script syntax
  FEATURES.md                       Feature system details
  SQL_CONVENTIONS.md                Redirect → see wrm-data-builder
  EXAMPLES.md                       Real project examples
  README.md                         Skill readme

wrm-data-builder/
  SKILL.md                          Claude Code skill
  WRM_ANNOTATIONS.md                COMMENT ON keyword reference
  WRM_CONFLICTS.md                  Reserved column names per feature
  FEATURE_ASSESSMENT.md             Feature detection heuristics
  SQL_PATTERNS.md                   Copy-paste SQL templates
  README.md                         Skill readme
  adapters/
    generic.md                      Any tool — paste as system prompt
    cursor.mdc                      Cursor rules (.cursor/rules/)
    copilot-instructions.md         GitHub Copilot (.github/)
    windsurf.rules                  Windsurf (.windsurfrules)

Requirements

  • WormScript (WRM) — dotnet tool install --global Wrm
  • PostgreSQL 13+
  • .NET 9.0 SDK (for generated projects)

Issues and contributions

WormScript and these skills are developed by Furniss Software.