Skip to content
n8n-conventions logo

n8n Quick Reference

n8n-conventions

Quick reference for n8n patterns. Full docs /AGENTS.md

Carrerajorge/Hola0installs1stars

SKILL.md

Full skill instructions

n8n Quick Reference

📚 Full Documentation:

  • General: /​AGENTS.md - Architecture, commands, workflows
  • Frontend: /​packages/​frontend/​AGENTS.md - CSS variables, timing

Use this skill when you need quick reminders on critical patterns.

Critical Rules (Must Follow)

TypeScript:

  • Never any → use unknown
  • Prefer satisfies over as (except tests)
  • Shared types in @n8n/​api-types

Error Handling:

import { UnexpectedError } from 'n8n-workflow';
throw new UnexpectedError('message', { extra: { context } });
// DON'T use deprecated ApplicationError

Frontend:

  • Vue 3 Composition API (<script setup lang="ts">)
  • CSS variables (never hardcode px) - see /​packages/​frontend/​AGENTS.md
  • All text via i18n ($t('key'))
  • data-testid for E2E (single value, no spaces)

Backend:

  • Controller → Service → Repository
  • Dependency injection via @n8n/​di
  • Config via @n8n/​config
  • Zod schemas for validation

Testing:

  • Vitest (unit), Playwright (E2E)
  • Mock external dependencies
  • Work from package directory: pushd packages/​cli && pnpm test

Database:

  • SQLite/​PostgreSQL only (app DB)
  • Exception: DB nodes (MySQL Node, etc.) can use DB-specific features

Commands:

pnpm build > build.log 2>&1  # Always redirect
pnpm typecheck               # Before commit
pnpm lint                    # Before commit

Key Packages

PackagePurpose
packages/​cliBackend API
packages/​frontend/​editor-uiVue 3 frontend
packages/​@n8n/​api-typesShared types
packages/​@n8n/​dbTypeORM entities
packages/​workflowCore interfaces

Common Patterns

Pinia Store:

import { STORES } from '@n8n/​stores';
export const useMyStore = defineStore(STORES.MY_STORE, () => {
  const state = shallowRef([]);
  return { state };
});

Vue Component:

<script setup lang="ts">
type Props = { title: string };
const props = defineProps<Props>();
</​script>

Service:

import { Service } from '@n8n/​di';
import { Config } from '@n8n/​config';

@Service()
export class MyService {
  constructor(private readonly config: Config) {}
}

📖 Need more details? Read /​AGENTS.md and /​packages/​frontend/​AGENTS.md

More skills from Carrerajorge

blogwatcher logo
Carrerajorge/Hola

blogwatcher

Monitor blogs and RSS/Atom feeds for updates using the blogwatcher CLI.

1 0
View
imsg logo
Carrerajorge/Hola

imsg

iMessage/SMS CLI for listing chats, history, and sending messages via Messages.app.

1 0
View
things-mac logo
Carrerajorge/Hola

things-mac

Manage Things 3 via the `things` CLI on macOS (add/update projects+todos via URL scheme; read/search/list from the local Things database). Use when a user asks OpenClaw to add a task to Things, list inbox/today/upcoming, search tasks, or inspect projects/areas/tags.

1 0
View

Composition patterns for building flexible, maintainable React components. Avoid boolean prop proliferation by using compound components, lifting state, and composing internals. These patterns make codebases easier for both humans and AI agents to work with as they scale.

1 0
View
blucli logo
Carrerajorge/Hola

blucli

BluOS CLI (blu) for discovery, playback, grouping, and volume.

1 0
View
nano-banana-pro logo
Carrerajorge/Hola

nano-banana-pro

Generate or edit images via Gemini 3 Pro Image (Nano Banana Pro).

1 0
View
linear-issue logo
Carrerajorge/Hola

linear-issue

Fetch and analyze Linear issue with all related context. Use when starting work on a Linear ticket, analyzing issues, or gathering context about a Linear issue.

1 0
View
gifgrep logo
Carrerajorge/Hola

gifgrep

Search GIF providers with CLI/TUI, download results, and extract stills/sheets.

1 0
View
content-design logo
Carrerajorge/Hola

content-design

Product content designer for UI copy. Use when writing, reviewing, or auditing user-facing text: button labels, error messages, tooltips, empty states, modal copy, placeholder text, confirmation dialogs, onboarding flows, or i18n strings. Also use when the user says /copy, /content, or /ux-copy.

1 0
View
slack logo
Carrerajorge/Hola

slack

Use when you need to control Slack from OpenClaw via the slack tool, including reacting to messages or pinning/unpinning items in Slack channels or DMs.

1 0
View
eightctl logo
Carrerajorge/Hola

eightctl

Control Eight Sleep pods (status, temperature, alarms, schedules).

1 0
View
sonoscli logo
Carrerajorge/Hola

sonoscli

Control Sonos speakers (discover/status/play/volume/group).

1 0
View

Popular AI tools

Kaiber logo
Video

Kaiber

Generate, edit, and beat-sync AI video with leading models in one workspace.

Paid
View
Vimcal logo
Productivity

Vimcal

The world's fastest calendar for remote work

Free
View

Transform Your Design with AI Designer by ImgCreator.ai

Freemium
View
Akool AI logo
Content & writing

Akool AI

Revolutionizing Video Production with AI-Powered Creativity

Paid
View

Extend an image past the frame and let AI fill the new aspect ratio.

Freemium
View
StarByFace logo
Security

StarByFace

Discover your celebrity doppelgänger with StarByFace!

Free
View
C

ChainClarity explains 700+ crypto whitepapers in plain English, with layered summaries, comparisons, research tools, alerts, and a $4.99 Pro plan.

Freemium
View
Opus Clip logo
Coding & apps

Opus Clip

Opus.ai: Revolutionize Your Web Experience

Free
View