ckit2

Next-generation Chatbot Kit nodes for n8n

Package Information

Released: 5 mo ago
Downloads: 13 weekly / 63 monthly
Latest Version: 0.2.0
Author: Danilo Luiz Rheinheimer

Documentation

@chatbot-kit/n8n-nodes-ckit2

@chatbot-kit/n8n-nodes-ckit2 is the new major line of Chatbot Kit community nodes for n8n.

This repository is being prepared as a clean base for the next version of the integration. The initial package structure is in place, but the production node implementation is still under development.

Installation

Follow the n8n community nodes installation guide.

Status

Current status:

  • Package scaffold created
  • Initial node placeholder registered
  • Final resources, operations, credentials, and compatibility details still being defined

Local Testing

Use two terminals during development.

Terminal 1:

npm run dev

This command:

  • builds the node
  • prepares a clean development package in .n8n-dev-package
  • starts TypeScript watch mode

Terminal 2:

npm run dev:n8n

This command:

  • prepares the clean development package again
  • starts a dedicated local n8n runner using the same user folder at .n8n-node-cli

Testing after changes

If you changed TypeScript files in the node:

  1. keep npm run dev running
  2. run npm run dev:prepare
  3. restart npm run dev:n8n

You usually do not need to restart npm run dev unless you changed development scripts, package metadata, or the local development setup itself.

Debugging

The preferred debug flow is VS Code with the local launch configuration.

  1. Open this repository in VS Code.

  2. Select Debug n8n custom node in the Run and Debug panel.

  3. Press F5.

This starts the TypeScript watcher, starts the local n8n runner in debug mode,
and attaches VS Code to the Node.js inspector on port 9240.

The local n8n editor is available at:

http://localhost:5678

You can use normal VS Code breakpoints in TypeScript files under nodes/.
You can also place a temporary debugger; statement where execution should
pause.

If port 9240 is already in use, update both places:

  • dev:n8n:debug in package.json
  • port in .vscode/launch.json

Manual Debugging

If you do not want to use VS Code launch tasks, run:

npm run dev

In another terminal:

npm run dev:n8n:debug

Then attach a debugger to localhost:9240.

Release to npm

This package is published by GitHub Actions, not directly from a local machine.
The local release command creates the version commit, changelog update, Git tag,
and GitHub release. The tag push then triggers .github/workflows/publish.yml,
which runs lint, builds the package, and publishes to npm with provenance.

One-time setup

Before releasing, make sure:

  • The GitHub repository is public. npm provenance for GitHub Actions does not
    support private source repositories.
  • The GitHub repository has an Actions secret named NPM_TOKEN.
  • The NPM_TOKEN is an npm automation/granular token with permission to publish
    under the @chatbot-kit scope.
  • The npm package is public. This is configured through
    publishConfig.access = "public" in package.json.

Release steps

  1. Make sure the working tree is clean:
git status
  1. Run the release command:
npm run release
  1. Select the version increment when prompted.

  2. Confirm the changelog update, release commit, tag, push, and GitHub release
    prompts.

  3. Open GitHub Actions and verify that the Publish workflow completed
    successfully.

  4. Confirm the published version on npm:

npm view @chatbot-kit/n8n-nodes-ckit2 version

Do not run npm publish manually. The prepublishOnly script blocks local
publishing so releases go through GitHub Actions with npm provenance.

Resources

Discussion