EtienneLescot/n8n-as-code

<div align="center">

<img src="res/logo.png" alt="n8n-as-code" width="40" height="40"> n8n-as-code

n8n을 위한 에이전틱 툴킷.

VS Code / Cursor Agent · n8n Environments · n8n-manager · GitOps · AI Skills · TypeScript Workflows

<br>

<img src="res/n8n-as-code-intro.gif" alt="n8n-as-code intro" width="800">

<br>

에디터에서 라이브 n8n 컨텍스트를 가진 에이전트로 n8n 워크플로우를 빌드, 편집, 배포, 디버그하세요.

문서 · 시작하기 · VS Code 가이드 · CLI 가이드

</div>

n8n 버전 호환성 — n8n-as-code에 번들된 노드 스키마는 n8n의 최신 안정 릴리스를 기준으로 빌드됩니다. 최상의 생성 및 검증 결과를 위해 n8n 인스턴스를 최신 상태로 유지하세요.

독립 프로젝트 — n8n-as-code는 독립적인 커뮤니티 프로젝트이며, n8n과 제휴, 보증 또는 후원 관계가 아닙니다.

n8n-as-code가 제공하는 것

n8n-as-code는 저장소를 완전한 n8n 개발 워크스페이스로 전환합니다:

저장소는 워크플로우 파일, 생성된 에이전트 컨텍스트, 워크스페이스 안전 구성을 저장합니다. 비밀 및 머신 로컬 런타임 상태는 로컬에 유지됩니다.

빠른 시작

VS Code / Cursor

1. VS Code Marketplace 또는 Open VSX에서 확장 프로그램을 설치합니다.
2. 폴더 또는 .code-workspace를 엽니다.
3. 확장 프로그램 아이콘을 클릭한 다음 톱니바퀴 아이콘을 클릭하여 워크스페이스를 구성합니다.
4. n8n 환경을 생성하거나 선택합니다.
5. 통합 Agent Workbench 또는 원하는 에이전트를 사용하여 워크플로우를 풀(pull)하거나 생성합니다.

구성 UI는 CLI와 동일한 모델을 사용합니다: 워크스페이스 환경은 저장소 컨텍스트이고, 로컬 관리 인스턴스는 머신 리소스입니다.

VS Code / Cursor 가이드

Claude Code

/plugin marketplace add https://github.com/EtienneLescot/n8n-as-code
/plugin install n8n-as-code@n8nac-marketplace

그런 다음 원하는 워크플로우를 Claude에게 요청하세요. n8n-architect 스킬이 필요에 따라 워크스페이스 설정, n8n 컨텍스트, 검증 및 동기화 단계를 처리합니다.

Claude 설정 문서

일반 에이전트 스킬

저장소의 skills 디렉토리에서 스킬을 설치합니다:

https://github.com/EtienneLescot/n8n-as-code/tree/main/skills

그런 다음 원하는 워크플로우를 에이전트에게 요청하세요. 스킬은 에이전트가 나머지를 처리하는 데 필요한 n8n 스키마, 예제, 검증 규칙 및 워크스페이스 명령을 제공합니다.

에이전트가 명시적인 스킬 경로를 요청하는 경우 skills/n8n-architect를 사용하세요.

스킬 참조

CLI

기존 n8n URL에 대한 워크스페이스 환경 생성:

npx --yes n8nac env add Dev --base-url https://n8n.example.com --workflows-path workflows/dev
printf '%s' "$N8N_API_KEY" | npx --yes n8nac env auth set Dev --api-key-stdin
npx --yes n8nac env use Dev
npx --yes n8nac update-ai

또는 로컬 관리 인스턴스 연결:

n8n-manager instance list
npx --yes n8nac env add Local --managed-instance <id> --workflows-path workflows/local
npx --yes n8nac env use Local

그런 다음 워크플로우를 명시적으로 동기화:

npx --yes n8nac list
npx --yes n8nac pull <workflow-id>
npx --yes n8nac push workflows/dev/my-workflow.workflow.ts --verify
npx --yes n8nac promote --from Dev --to Prod --dry-run

promote를 사용하여 한 환경의 workflowsPath에서 다른 환경으로 워크플로우 소스를 이동합니다. 단일 워크플로우의 경우 워크플로우 경로를 전달하고, 생략하면 중첩 폴더를 포함하여 소스 환경의 모든 *.workflow.ts 파일을 승격합니다. 승격은 대상 프로젝트 메타데이터를 다시 작성하고, 자격 증명 및 지원되는 Execute Workflow 참조를 다시 매핑하며, n8nac-promotion.json에 안정적인 소스-대상 바인딩을 기록하고, --no-push가 설정되지 않은 경우 기본적으로 푸시합니다. --dry-run은 정확한 생성/업데이트 계획을 위한 검색을 수행하지만 파일을 쓰거나, 푸시하거나, 승격 구성을 업데이트하지 않습니다.

CLI 가이드 · n8n-manager 가이드

명령 그룹

주요 사용법: n8nac env

n8nac env list
n8nac env add Dev --base-url <url> --workflows-path workflows/dev
n8nac env add Local --managed-instance <id> --workflows-path workflows/local
n8nac env use Dev
n8nac env auth set Dev --api-key-stdin
n8nac env remove Dev

이 저장소가 n8n에 연결되는 방식을 설명하는 모든 것에 n8nac env를 사용하세요.

워크스페이스 검사: n8nac workspace

n8nac workspace status --json
n8nac env status --json

활성 환경 준비 상태의 진실 공급원으로 env status --json을 사용하세요.

관리형 로컬 인스턴스: n8n-manager

n8n-manager instance list
n8n-manager instance create
n8n-manager instance start <id>
n8n-manager instance stop <id>
n8n-manager instance remove <id>
n8n-manager tunnel start <id>
n8n-manager tunnel stop <id>

로컬 관리 인스턴스 및 머신 로컬 작업에만 n8n-manager를 사용하세요. 워크스페이스 진실 공급원으로 사용하지 마세요.

n8n을 위한 GitOps

n8nac env use Dev
n8nac list
n8nac pull <workflow-id>
n8nac push workflows/dev/my-workflow.workflow.ts --verify
n8nac resolve <workflow-id> --mode keep-current

동기화는 명시적입니다. 요청하지 않으면 아무것도 푸시되거나 풀되지 않습니다.

AI 스킬

스킬 레이어는 에이전트에게 근거 있는 n8n 지식(노드 스키마, 문서, 예제, 템플릿, 검증 규칙 및 안전한 워크플로우 작업)을 제공합니다.

npx --yes n8nac skills search "send slack message when google sheet is updated"
npx --yes n8nac skills node-info slack
npx --yes n8nac skills validate workflows/dev/my-workflow.workflow.ts

TypeScript 워크플로우

import { workflow, node, links } from '@n8n-as-code/transformer';

@workflow({ id: 'abc123', name: 'Slack Notifier', active: true })
export class SlackNotifierWorkflow {
  @node()
  Trigger = {
    type: 'n8n-nodes-base.webhook',
    parameters: { path: '/notify', method: 'POST' },
    position: [250, 300],
  };

  @node()
  Slack = {
    type: 'n8n-nodes-base.slack',
    parameters: {
      resource: 'message',
      operation: 'post',
      channel: '#alerts',
      text: '={{ $json.message }}',
    },
    position: [450, 300],
  };

  @links([{ from: 'Trigger', to: 'Slack' }])
  connections = {};
}

n8nac convert workflow.json --format typescript
n8nac convert-batch workflows/ --format typescript

패키지

구성 요소가 어떻게 맞물리는지

• VS Code/Cursor 확장 프로그램: 시각적 워크플로우 워크스페이스 및 통합 Agent Workbench.
• n8nac env: 저장소 수준 환경 진실 공급원.
• n8nac workspace: 준비 상태 및 통합 워크스페이스 마이그레이션.
• n8n-manager: 로컬 관리 인스턴스, Docker 수명 주기, 터널 및 머신 로컬 비밀.
• Skills 및 MCP: 에이전트를 위한 근거 있는 n8n 지식.

기여하기

기여를 환영합니다.

1. 프로젝트를 포크합니다.
2. 브랜치를 생성합니다: git checkout -b feature/amazing.
3. 테스트를 실행합니다: npm test.
4. Pull Request를 엽니다.

라이선스

MIT 라이선스 — 자유롭게 사용, 수정 및 배포할 수 있습니다.

타사 커뮤니티 워크플로우 메타데이터 및 다운로드 가능한 워크플로우 파일은 각각의 업스트림 라이선스가 적용됩니다.

감사의 말

n8n-as-code는 n8n이 존재하기 때문에 존재합니다.

이 프로젝트가 기반으로 하는 워크플로우 자동화 플랫폼을 구축하고 유지 관리하는 n8n 팀과 커뮤니티에 감사드립니다.

<div align="center">

n8n-as-code가 시간을 절약해 준다면, 별표를 눌러주세요.

GitHub에서 별표 · 문서 · 버그 신고

</div>