Ship a skill with your module
Teach Claude Code, Codex and the DMS AI assistant how to use your module, with a SKILL.md file next to its code that package.json declares.
A module that ships a skill tells every agent when and how to use it, in the version the project installed. The antelopejs plugin links the skill into Claude Code and Codex, and the DMS AI assistant loads it. Nothing else needs configuring.
Write the skill
Create one folder per skill under skills/. Each folder holds a SKILL.md whose frontmatter has a name and a description that says when to use the skill:
---
name: dms-cookbook
description: Adds recipes, ingredients and meal plans to a DMS project with @acme/dms-cookbook. Use when the user wants recipe pages, a meal planner, or asks about the cookbook module.
icon: i-lucide-chef-hat
category: content
tags: [recipes, meal plans]
---
# Cookbook
Load the module in `antelope.config.ts`, then …
Declare it
In package.json, list the folder that holds your skills under antelopeJs.skills, and add it to files so that it ships with the package:
{
"files": ["dist", "frontend-vue", "skills"],
"antelopeJs": {
"skills": ["./skills"]
}
}
Check that it loads
In a project that installs your module, run /antelopejs:sync-skills in Claude Code. The skill appears as .claude/skills/<package>--dms-cookbook, where <package> is the package name without its scope. npx -y github:AntelopeJS/agent-skills sync fills both .claude/skills and .agents/skills, the folder Codex reads. For the DMS AI assistant, restart the backend.
Write the skill for an agent to read
- Name in the
descriptionthe cases that should load the skill. The agent always reads the description, and reads the body only when the description matches. - Put the steps in
SKILL.md. Move long reference material into aREFERENCE.mdnext to it, and link that file from the body. - For pages, auth and the dev servers, point to the
dms-*skills instead of repeating them. - Update the skill with the API it describes. It ships with each release of your package.