n8n-conventions

Reference n8n conventions for TypeScript, error handling, and testing.

200k|60.0k|Updated Jun 22, 2019

Search Tags:#typescript #vue #patterns #conventions #n8n #best-practices #coding-standards

Ready to run

npx skills add https://github.com/n8n-io/n8n --skill n8n-conventions

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: n8n-conventions
Source: https://github.com/n8n-io/n8n/tree/main/.claude/skills/n8n-conventions
Command: npx skills add https://github.com/n8n-io/n8n --skill n8n-conventions

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides a quick reference to essential n8n conventions and patterns.

Core Features & Use Cases

Quick reference to general docs: AGENTS.md and frontend patterns in /packages/frontend/AGENTS.md
Encodes critical rules for TypeScript, error handling, frontend, backend, testing, and commands
Use case: When starting a new node, workflow, or UI component, consult this skill to align with n8n conventions.

Quick Start

Open the skill to review the core n8n conventions and consult the linked documentation: AGENTS.md and /packages/frontend/AGENTS.md for deeper guidance.

Frequently Asked Questions about n8n-conventions

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

FAQPage Schema

What are the standard TypeScript conventions for developing n8n nodes?▼

Standard n8n TypeScript conventions codify actionable rules for error handling, architecture, and testing to align node, workflow, and UI component development with project guidelines.

How do I apply frontend coding standards when building n8n UI components in Vue?▼

Apply n8n frontend coding standards by consulting the AGENTS.md and packages/frontend/AGENTS.md documentation to follow established Vue patterns and architectural rules.

Does this n8n conventions reference cover backend architecture and testing commands?▼

Yes, the n8n conventions reference encodes critical rules for backend architecture, testing, and associated commands alongside TypeScript and frontend development guidelines.

When should I consult n8n best practices during workflow development?▼

Consult n8n best practices when starting a new node, workflow, or UI component to ensure your implementation aligns with required TypeScript, error handling, and testing conventions.

What is the best way to ensure my custom n8n node aligns with project patterns?▼

The best way to align custom n8n nodes with project patterns is to review the core conventions skill and consult the linked AGENTS.md documentation for deeper guidance.