Quick Start (Install & Run)

Get up and running with the DocuWriter.ai community n8n nodes in a few simple steps.

Prerequisites

• 🖥 Node.js ≥ 18.10
• 📦 pnpm (or npm/yarn)
• 🔧 n8n CLI or Docker installation
• 📂 A clone of this repo:

  git clone https://github.com/DocuWriter-ai/n8n-nodes-docuwriter-ai.git
  

Installation & Build

1. Change into the project directory

   cd n8n-nodes-docuwriter-ai
   

2. Install dependencies

   pnpm install
   

3. Compile to dist/

   pnpm run build
   

{
  "commands": {
    "npm": "npm install",
    "yarn": "yarn",
    "pnpm": "pnpm install",
    "bun": "bun install"
  }
}

Running Locally

• n8n CLI

  # From project root
  n8n start --tunnel
  

• Docker

  docker run -it --rm \
    -v ~/.n8n:/home/node/.n8n \
    -v $PWD/dist:/home/node/custom \
    -p 5678:5678 \
    n8nio/n8n
  

n8n Registration

To make n8n load the compiled nodes and credentials, wire them in your n8n config. You can either:

• Drop files into your $HOME/.n8n/credentials and $HOME/.n8n/nodes folders
• Reference them in a custom config.json

Example ~/.n8n/config.json

{
  "nodes": [
    "dist/nodes/DocuWriter/DocuWriter.node.js",
    "dist/nodes/DocuWriterTrigger/DocuWriterTrigger.node.js"
  ],
  "credentials": [
    "dist/credentials/DocuWriterApi.credentials.js"
  ]
}

Files to Register

Note: After updating your config, restart n8n to pick up new nodes.

With these steps, you can now start building n8n workflows that leverage DocuWriter.ai to auto‐generate documentation, tests, comments, UML diagrams, and retrieve generation metadata. 🚀