n8n-node 도구는 n8n용 커뮤니티 노드를 개발하기 위한 공식 CLI입니다. 이 도구를 사용하여 새 노드를 스캐폴딩하고, 프로젝트를 빌드하고, 개발하는 동안 노드를 실행할 수 있습니다.

n8n-node를 사용하면 검증된 커뮤니티 노드 가이드라인을 준수하는 노드를 만들 수 있습니다.

n8n-node 받기#

설치 없이 n8n-node 실행하기#

패키지 관리자와 함께 @n8n/create-node 초기화 도구를 사용하면 설치하지 않고도 n8n-node 프로젝트를 직접 생성할 수 있습니다.

npm create @n8n/node@latest

이 명령은 로컬에 초기 프로젝트 파일을 설정합니다(n8n-node를 로컬에 설치하고 new 명령을 명시적으로 실행하는 것의 대안입니다). 이후에는 프로젝트 디렉터리 내에서 패키지 관리자의 스크립트 러너를 통해 나머지 n8n-node 명령을 실행합니다(예: npm run dev).

n8n-node 전역 설치하기#

npm으로 n8n-node를 전역 설치할 수 있습니다.

npm install --global @n8n/node-cli

다음을 입력하여 명령에 접근할 수 있는지 확인하세요.

n8n-node --version

명령 개요#

n8n-node 도구는 다음 명령을 제공합니다.

new#

new 명령은 새 노드의 파일 시스템 구조와 메타데이터를 생성합니다. 이 명령은 설치 없이 n8n-node 실행하기에서 설명한 것과 동일한 구조로 초기화합니다.

호출되면 프로젝트에 관한 세부 정보를 대화형으로 묻고 시작 코드를 사용자 지정합니다. 프로젝트 이름을 입력하고, 노드 유형을 선택하고, 필요에 가장 잘 맞는 시작 템플릿을 선택합니다. n8n-node 도구는 프로젝트 파일 구조를 생성하고, 선택적으로 초기 프로젝트 의존성을 설치합니다.

new 명령을 사용하는 방법에 대해 자세히 알아보려면 새 노드 만들기 섹션을 참조하세요.

build#

build 명령은 노드를 컴파일하고 필요한 모든 자산을 복사합니다.

build 명령을 사용하는 방법에 대해 자세히 알아보려면 노드 빌드하기 섹션을 참조하세요.

dev#

dev 명령은 노드와 함께 n8n을 실행합니다. 프로젝트 디렉터리를 모니터링하며 변경 사항을 감지하면 라이브 미리보기를 자동으로 다시 빌드합니다.

dev 명령을 사용하는 방법에 대해 자세히 알아보려면 n8n에서 노드 테스트하기 섹션을 참조하세요.

lint#

lint 명령은 현재 디렉터리에 있는 노드의 코드를 검사합니다. --fix 옵션을 선택적으로 사용하면 발견된 문제를 자동으로 수정하려고 시도합니다.

lint 명령을 사용하는 방법에 대해 자세히 알아보려면 노드 린트하기 섹션을 참조하세요.

release#

release 명령은 커뮤니티 노드 패키지를 npm에 게시합니다. release-it을 사용하여 패키지를 npm에 게시하기 전에 정리하고, 확인하고, 깔끔하게 빌드합니다.

release 명령을 사용하는 방법에 대해 자세히 알아보려면 노드 릴리즈하기 섹션을 참조하세요.

새 노드 만들기#

n8n-node로 새 노드를 만들려면 n8n-node new를 호출하세요. 이 명령은 완전히 대화형으로 호출하거나 명령줄에서 세부 정보를 제공하여 호출할 수 있습니다.

npm create @n8n/node@latest n8n-nodes-mynode -- --template declarative/custom

이 명령은 노드에 관해 누락된 정보를 물어본 다음, 시작에 필요한 프로젝트 구조를 생성합니다. 기본적으로 이어서 초기 프로젝트 의존성을 설치합니다(--skip-install 플래그를 전달하여 비활성화할 수 있습니다).

대화형으로 노드 세부 정보 설정하기#

인자 없이 호출하면 n8n-node new는 새 노드에 관한 세부 정보를 대화형으로 묻습니다.

n8n-node new

그러면 프로젝트의 세부 정보를 정의할 수 있는 대화형 프롬프트가 시작됩니다.

• 노드 이름이 무엇입니까? 노드의 이름입니다. 이는 프로젝트 디렉터리 이름, 패키지 이름, n8n 노드 자체의 이름에 영향을 미칩니다. 이름은 다음 형식 중 하나를 사용해야 합니다.
  • n8n-nodes-
  • @/n8n-nodes-
• 어떤 종류의 노드를 만들고 있습니까? 만들고자 하는 노드 유형입니다.
  • HTTP API: n8n Cloud에서 더 빠른 승인을 받을 수 있도록 설계된 로우코드 선언적 노드 구조입니다.
  • Other: 완전한 유연성을 갖춘 프로그래밍 방식 노드입니다.
• 어떤 템플릿을 사용하고 싶습니까? HTTP API를 사용할 때 시작할 템플릿을 선택할 수 있습니다.
  • GitHub Issues API: 여러 작업과 자격 증명을 포함하는 데모 노드입니다. 노드 구조와 규칙에 익숙해지는 데 도움이 됩니다.
  • Start from scratch: 몇 가지 추가 프롬프트를 통해 사용자 지정 설정을 안내하는 빈 템플릿입니다.

HTTP API > Start from scratch를 선택하면 n8n-node가 다음을 묻습니다.

• API의 기본 URL은 무엇입니까? 연동하려는 API의 루트 URL입니다.
• API가 어떤 유형의 인증을 사용합니까? 노드가 제공해야 하는 인증 방식입니다.
  • API Key: 헤더, 쿼리 매개변수, 또는 요청 본문을 사용하여 비밀 키를 전송합니다.
  • Bearer Token: Authorization 헤더를 사용하여 토큰을 전송합니다(Authorization: Bearer <token>).
  • OAuth2: OAuth 2.0 흐름을 사용하여 사용자 또는 앱을 대신해 액세스 토큰을 가져옵니다.
  • Basic Auth: Authorization 헤더를 통해 base64로 인코딩된 사용자 이름과 비밀번호를 전송합니다.
  • Custom: 필요에 따라 사용자 지정할 수 있는 나만의 자격 증명 로직을 만듭니다. 이렇게 하면 빈 자격 증명 클래스가 생성됩니다.
  • None: 인증이 필요하지 않습니다. 노드에 대한 자격 증명 클래스를 만들지 않습니다.

선택을 마치면 n8n-node는 현재 디렉터리에 노드를 위한 새 프로젝트 디렉터리를 만듭니다. 기본적으로 초기 프로젝트 의존성도 설치합니다(--skip-install 플래그를 전달하여 비활성화할 수 있습니다).

명령줄에서 노드 세부 정보 제공하기#

프롬프트를 피하기 위해 명령줄에서 노드 세부 정보 중 일부를 제공할 수 있습니다.

노드에 사용하려는 이름을 인자로 포함할 수 있습니다.

n8n-node new n8n-nodes-myproject

사용하려는 템플릿을 미리 알고 있다면 --template 플래그를 사용하여 값을 전달할 수도 있습니다.

n8n-node new --template declarative/custom

템플릿은 다음 중 하나여야 합니다.

• declarative/github-issues: 여러 작업과 자격 증명을 포함하는 데모 노드입니다. 노드 구조와 규칙에 익숙해지는 데 도움이 됩니다.
• declarative/custom: 몇 가지 추가 프롬프트를 통해 사용자 지정 설정을 안내하는 빈 템플릿입니다.
• programmatic/example: 완전한 유연성을 갖춘 프로그래밍 방식 노드입니다.

노드 빌드하기#

프로젝트의 루트 디렉터리에서 build 명령을 실행하여 노드를 빌드할 수 있습니다.

n8n-node build

n8n-node는 TypeScript 파일을 컴파일하고 다른 프로젝트 자산을 번들로 묶습니다. 패키지 관리자에서 build 스크립트를 호출할 수도 있습니다. 예를 들어 npm을 사용하는 경우, 다음과 같이 해도 동일하게 동작합니다.

npm run build

노드 린트하기#

n8n-node 도구는 프로젝트에 대한 lint 스크립트도 자동으로 생성합니다. 패키지 관리자로 이 스크립트를 실행할 수 있습니다. 예를 들면 다음과 같습니다.

n8n-node lint

패키지 관리자의 스크립트 러너를 통해서도 실행할 수 있습니다.

npm run lint

--fix 옵션을 포함하면(npm run lint:fix로도 호출할 수 있습니다), n8n-node는 발견한 문제를 수정하려고 시도합니다.

n8n-node lint --fix

n8n에서 노드 테스트하기#

n8n에서 노드를 테스트하려면 프로젝트의 루트 디렉터리에서 dev 명령을 실행합니다.

n8n-node dev

build 명령과 마찬가지로 패키지 관리자를 통해서도 이 명령을 실행할 수 있습니다. 예를 들면 다음과 같습니다.

npm run dev

n8n-node는 프로젝트를 컴파일한 다음, 노드가 로드된 상태로 npm을 통해 로컬 n8n 인스턴스를 시작합니다.

localhost:5678에 접속하여 n8n 인스턴스에 로그인하세요. 워크플로를 열면 노드 패널에 노드가 나타납니다.

여기서부터 워크플로에 노드를 추가하고, 개발하면서 노드의 기능을 테스트할 수 있습니다.

노드 릴리즈하기#

노드를 게시하려면 프로젝트 디렉터리에서 release 명령을 실행하세요. 이 명령은 release-it을 사용하여 노드를 빌드하고 게시합니다.

n8n-node release

npm으로 실행하려면 다음과 같이 입력하세요.

npm run release

release 명령을 실행하면 n8n-node는 다음 작업을 수행합니다.

• 노드 빌드
• 파일에 대한 린트 검사 실행
• 변경 로그 업데이트
• git 태그 생성
• GitHub 릴리즈 생성
• npm에 패키지 게시