Nile Js skill

Use Nile’s SKILL.md to give a coding assistant the service layout, action pattern, FP conventions and common mistakes. The package includes a copy matching your installed version.

What the skill coversCopy Anchor Link

• The project layout of a CLI starter and where the service registry lives.
• The action pattern: a named Zod schema, an inferred input type, a named handler and createAction.
• That handlers receive (data, context), and which context fields to use.
• Results, the HTTP response envelope and the per-field data.issues on validation failures.
• Calling actions over HTTP, with @nilejs/client and with server.invoke.
• Authentication, hooks and discovery rules.
• Links to every feature page.
• Rules for agents, such as reading services.config.ts first and type-checking after every edit.
• Common pitfalls, such as accessControl not blocking anything without a hook.

The CLI starter includes the same guidance as a project-root SKILL.md. Nile’s package file is the reference after an upgrade; refresh a copied starter skill from it.

The skill covers strict startup layout checks, returning Results directly, safe database diagnostics, generated validation references, and separate HTTP/socket clients. Its examples follow the same domain entry points as the starter.

Find the fileCopy Anchor Link

After bun install, the skill is in your project at:

node_modules/@nilejs/nile/SKILL.md

Open it to see exactly what your assistant will read. The file starts with name, description and license fields that skill-aware assistants use to decide when to load it.

Install it for Claude CodeCopy Anchor Link

Claude Code loads project skills from .claude/skills/<name>/SKILL.md. The skill's name is nile, so create that folder and link the file from the package:

mkdir -p .claude/skills/nile
ln -s ../../../node_modules/@nilejs/nile/SKILL.md .claude/skills/nile/SKILL.md

You should see .claude/skills/nile/SKILL.md pointing at the package file. The link follows upgrades automatically. If your setup does not allow symbolic links, copy the file instead and copy it again after each upgrade:

cp node_modules/@nilejs/nile/SKILL.md .claude/skills/nile/SKILL.md

Commit the .claude/skills/nile/ folder so everyone on the team gets the same instructions.

Use it with other assistantsCopy Anchor Link

Assistants that read an AGENTS.md file, or their own rules file, can follow the skill through a short instruction. Add this to AGENTS.md in the project root:

Before changing the backend, read node_modules/@nilejs/nile/SKILL.md and follow it.

For an assistant without file access, paste the contents of SKILL.md into its project instructions.

Keep it currentCopy Anchor Link

The skill describes the installed release. After you upgrade @nilejs/nile, a linked skill updates by itself; a copied skill needs to be copied again. When the skill and your code disagree, trust the code and the installed types, and tell the assistant which one is right.

See alsoCopy Anchor Link

• Build with AI agents
• Documentation for coding agents
• Discovery and agents