Install the n8n node
npm install, npm link, or file dependency — Linux, macOS, and Windows.
On this page
Install the community node into n8n's custom extensions directory. After npm publish, use npm install n8n-nodes-caedral. Until then, use npm link or a file: dependency from the monorepo.
Install from npm (after publish)
# Linux / macOSmkdir -p ~/.n8n/custom && cd ~/.n8n/customnpm init -ynpm install n8n-nodes-caedral # Restart n8n completely# Windowsmkdir $env:USERPROFILE\.n8n\custom -Forcecd $env:USERPROFILE\.n8n\customnpm init -ynpm install n8n-nodes-caedral # Restart n8nLocal development (npm link)
Link the monorepo package while testing against a local API gateway on port 5001.
cd n8n-nodes-caedralnpm install && npm run buildnpm link mkdir -p ~/.n8n/custom && cd ~/.n8n/customnpm init -ynpm link n8n-nodes-caedral # Restart n8nfile: dependency (no global link)
In ~/.n8n/custom/package.json add a file path to the monorepo folder:
{ "dependencies": { "n8n-nodes-caedral": "file:/path/to/ceadral/n8n-nodes-caedral" }}Run npm install in ~/.n8n/custom and restart n8n.
Verify installation
- Restart n8n (required after any custom node install)
- Open the node panel and search for Caedral
- Add a Caedral node — you should see Chat Completion and Get Usage operations