AI assistants
If you code with an AI assistant, give it the nest-crud skill: a short guide to the package's conventions (which hook scopes what, how counts and bulk routes work, what not to do), so it writes code the way the package expects.
There are two skills, one per side:
| Project | Skill covers | Install |
|---|---|---|
| API (NestJS) | resources, hooks, tenant scoping, bulk routes, custom routes | npx @ackplus/nest-crud add-skill |
| Frontend / client (TS, JS) | building queries with QueryBuilder, counts, aggregates, bulk calls | npx @ackplus/nest-crud-request add-skill |
Install the skill
Each skill ships inside its package, so it always matches your installed version. Run the command for your project (both take the same options):
npx @ackplus/nest-crud add-skill # API project
npx @ackplus/nest-crud-request add-skill # frontend projectBy default it writes a Claude Code skill and adds a section to AGENTS.md. Pick other tools with --tool:
--tool | Writes |
|---|---|
claude | .claude/skills/<package>/SKILL.md |
agents | a marked section in AGENTS.md |
cursor | .cursor/rules/<package>.mdc |
copilot | a marked section in .github/copilot-instructions.md |
all | all of the above |
npx @ackplus/nest-crud add-skill --tool cursor,copilotSections are wrapped in <!-- nest-crud:start --> / <!-- nest-crud:end --> markers; re-running replaces only that block and leaves the rest of the file alone. Run it again after upgrading the package. Nothing is written at npm install time.
Without installing anything
Point your assistant at one of these links:
- Server skill: https://ack-solutions.github.io/nest-crud/skill.md
- Client skill: https://ack-solutions.github.io/nest-crud/skill-request.md
- Index of all docs: https://ack-solutions.github.io/nest-crud/llms.txt
For example: "Read https://ack-solutions.github.io/nest-crud/skill.md and follow it when working with nest-crud in this project."
Reporting a problem
If something in the package looks wrong, the skill tells the assistant not to patch node_modules or work around it silently, but to draft a bug report for you to review. You can also open one yourself: https://github.com/ack-solutions/nest-crud/issues/new/choose.