### Install http-server using npm

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/nodes-langchain/nodes/trigger/ChatTrigger/README.md

Installs the http-server package globally using npm, which is required for serving local files over HTTP.

```bash
npm install -g http-server
```

--------------------------------

### Start HTTPS Server with http-server

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/nodes-langchain/nodes/trigger/ChatTrigger/README.md

Starts a local HTTPS server using http-server to serve the built chat bundle files from the specified directory. It uses the generated certificate and key, enables CORS, and listens on port 8443.

```bash
http-server packages/frontend/@n8n/chat/dist -g -S -C cert.pem -K key.pem --port 8443 --cors
```

--------------------------------

### Install Dependencies and Build n8n

Source: https://github.com/kds2000a/n8n/blob/master/CONTRIBUTING.md

Commands to install all project dependencies using pnpm and build the n8n code.

```bash
pnpm install
pnpm build
```

--------------------------------

### Install project dependencies with pnpm

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/design-system/README.md

Installs all the necessary dependencies for the project using the pnpm package manager. This is typically the first step before running any other commands.

```shell
pnpm install
```

--------------------------------

### Start n8n Development and Production

Source: https://github.com/kds2000a/n8n/blob/master/CONTRIBUTING.md

Commands to start n8n for regular use and for development mode with automatic reloading.

```bash
pnpm start
./packages/cli/bin/n8n start --tunnel
pnpm dev
```

--------------------------------

### Install Build Tools (Windows)

Source: https://github.com/kds2000a/n8n/blob/master/CONTRIBUTING.md

Installs Windows build tools globally using npm, a requirement for n8n development on Windows.

```bash
npm add -g windows-build-tools
```

--------------------------------

### Install Build Tools (CentOS)

Source: https://github.com/kds2000a/n8n/blob/master/CONTRIBUTING.md

Installs necessary build tools for CentOS systems, required for n8n development.

```bash
yum install gcc gcc-c++ make
```

--------------------------------

### Install Build Tools (Debian/Ubuntu)

Source: https://github.com/kds2000a/n8n/blob/master/CONTRIBUTING.md

Installs necessary build tools for Debian/Ubuntu systems, required for n8n development.

```bash
apt-get install -y build-essential python
```

--------------------------------

### Install json-schema-to-zod

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/json-schema-to-zod/README.md

Installs the 'json-schema-to-zod' package using npm.

```sh
npm install @n8n/json-schema-to-zod
```

--------------------------------

### Install n8n-node-dev CLI

Source: https://github.com/kds2000a/n8n/blob/master/packages/node-dev/README.md

Installs the n8n-node-dev command-line interface globally using npm. This tool is essential for developing n8n nodes and credentials.

```bash
npm install n8n-node-dev -g
```

--------------------------------

### Build Chat Bundle with pnpm

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/nodes-langchain/nodes/trigger/ChatTrigger/README.md

Navigates to the chat package directory and builds the chat bundle using the 'build' script defined in its package.json, typically managed with pnpm.

```bash
cd packages/frontend/@n8n/chat && pnpm run build
```

--------------------------------

### Start Storybook for development and hot-reloading

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/design-system/README.md

Compiles and hot-reloads the Storybook environment for component development. This command allows for live preview and instant updates as code changes.

```shell
pnpm storybook
```

--------------------------------

### Install and Embed n8n Chat via npm

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/chat/README.md

Installs the n8n Chat package using npm and embeds it into a JavaScript application. This involves importing the necessary CSS and the createChat function, then initializing the chat with the webhook URL.

```sh
npm install @n8n/chat
```

```ts
import '@n8n/chat/style.css';
import { createChat } from '@n8n/chat';

createChat({
	webhookUrl: 'YOUR_PRODUCTION_WEBHOOK_URL'
});
```

--------------------------------

### Run Benchmark with Custom Scenarios via Docker

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/benchmark/README.md

Load custom benchmark scenarios using the n8n-benchmark Docker image. This example mounts a local 'scenarios' directory into the container and runs benchmarks using those custom scenarios.

```sh
# Assuming your scenarios are located in "./scenarios", mount them into "/scenarios" in the container
docker run -v ./scenarios:/scenarios ghcr.io/n8n-io/n8n-benchmark:latest run \
	--n8nBaseUrl=https://instance.url \
	--n8nUserEmail=InstanceOwner@email.com \
	--n8nUserPassword=InstanceOwnerPassword \
	--vus=5 \
	--duration=1m \
	--testScenariosPath=/scenarios
```

--------------------------------

### Run n8n with npx

Source: https://github.com/kds2000a/n8n/blob/master/README.md

Instantly try n8n using npx, which requires Node.js to be installed. This command initiates the n8n editor.

```shell
npx n8n
```

--------------------------------

### Node Parameter Translation Example

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/i18n/docs/README.md

This example shows how to translate 'displayName', 'placeholder', and 'description' for a string parameter named 'owner'.

```json
{
	"nodeView.owner.displayName": "🇩🇪 Repository Owner",
	"nodeView.owner.placeholder": "🇩🇪 n8n-io",
	"nodeView.owner.description": "🇩🇪 Owner of the repository"
}
```

--------------------------------

### Start n8n with Tunnel for Webhooks

Source: https://github.com/kds2000a/n8n/blob/master/docker/images/n8n/README.md

This snippet shows how to start n8n with a tunnel enabled, which is necessary for webhooks to trigger workflows from external services. It's intended for local development and testing only. The command includes creating a Docker volume and running the n8n container with the `--tunnel` argument.

```bash
docker volume create n8n_data

docker run -it --rm \
 --name n8n \
 -p 5678:5678 \
 -v n8n_data:/home/node/.n8n \
 docker.n8n.io/n8nio/n8n \
 start --tunnel
```

--------------------------------

### Start n8n in Docker

Source: https://github.com/kds2000a/n8n/blob/master/docker/images/n8n/README.md

This snippet demonstrates how to start the n8n service using Docker. It creates a Docker volume for persistent data storage and maps the container's port 5678 to the host machine. The workflow data, including webhook URLs and encryption keys, is saved in an SQLite database within the mounted volume.

```bash
docker volume create n8n_data

docker run -it --rm \
 --name n8n \
 -p 5678:5678 \
 -v n8n_data:/home/node/.n8n \
 docker.n8n.io/n8nio/n8n
```

--------------------------------

### Run Benchmark CLI Locally without Docker

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/benchmark/README.md

Execute the n8n-benchmark CLI locally without Docker. This requires building the project and having k6 and Node.js installed. The command runs tests against a local n8n instance using specified credentials.

```sh
pnpm build

# Run tests against http://localhost:5678 with specified email and password
N8N_USER_EMAIL=user@n8n.io N8N_USER_PASSWORD=password ./bin/n8n-benchmark run
```

--------------------------------

### Basic Resolvable Expression

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/codemirror-lang/test/expressions/cases.txt

This snippet shows a simple arithmetic operation within a resolvable block. It demonstrates the basic syntax for evaluating expressions in n8n.

```n8n
{{ 1 + 1 }}
```

--------------------------------

### Run n8n E2E Tests (PNPM)

Source: https://github.com/kds2000a/n8n/blob/master/CONTRIBUTING.md

Commands to install Cypress dependencies and run E2E tests in different modes: interactive UI, development mode with hot reloading, and headless mode.

```bash
pnpm cypress:install
pnpm test:e2e:ui
pnpm test:e2e:dev
pnpm test:e2e:all
```

--------------------------------

### Resolvable with Nested and Escaped Brackets

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/codemirror-lang/test/expressions/cases.txt

This example shows how n8n handles resolvable expressions with nested and escaped square brackets, including single, double, and triple bracket scenarios.

```n8n
{{ he [ abc ] llo }}
```

```n8n
{{ he [[ abc ]] llo }}
```

```n8n
{{ he [[[ abc ]]] llo }}
```

--------------------------------

### Set Default Locale and Start n8n

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/i18n/docs/README.md

This snippet demonstrates how to set the default locale for n8n using an environment variable and then start the n8n process. It shows the expected output indicating the locale being used.

```bash
export N8N_DEFAULT_LOCALE=de
pnpm start
```

--------------------------------

### Resolvable with Special Characters

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/codemirror-lang/test/expressions/cases.txt

This example illustrates how n8n handles resolvable expressions containing a wide array of special characters. It includes various symbols and punctuation marks within the expression.

```n8n
{{ he ()[]{<>~`!@#$%^&*-_+=|\;':",./?{ llo }}
```

--------------------------------

### String Parameter Translation Example

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/i18n/docs/README.md

Shows the translation keys for a string parameter, including 'displayName', 'placeholder', and 'description'.

```typescript
{
	displayName: 'Repository Owner',
	name: 'owner', // key to use in translation
	type: 'string',
	required: true,
	placeholder: 'n8n-io',
	description: 'Owner of the repository.',
},

```

--------------------------------

### Basic Dependency Injection with @n8n/di

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/di/README.md

Demonstrates how to use the @n8n/di container to inject services. It shows how to define services using the @Service() decorator and how to retrieve and use them via the Container.get() method. This example requires experimental decorators and emitDecoratorMetadata to be enabled in tsconfig.json.

```typescript
import { Container, Service } from 'typedi';

@Service()
class ExampleInjectedService {
  printMessage() {
    console.log('I am alive!');
  }
}

@Service()
class ExampleService {
  constructor(
    public injectedService: ExampleInjectedService
  ) {}
}

const serviceInstance = Container.get(ExampleService);
serviceInstance.injectedService.printMessage();
```

--------------------------------

### Mixed Plaintext and Resolvable Sequences

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/codemirror-lang/test/expressions/cases.txt

These snippets demonstrate various combinations of plaintext and resolvable expressions, showing how n8n parses sequences of plain text interspersed with evaluable expressions.

```n8n
text {{ 1 + 1 }}
```

```n8n
{{ 1 + 1 }} Plaintext
```

```n8n
text {{ 1 + 1 }} text
```

```n8n
{{ 1 + 1 }} text {{ 1 + 1 }}
```

```n8n
text {{ 1 + 1 }} text {{ 1 + 1 }}
```

```n8n
{{ 1 + 1 }} text {{ 1 + 1 }} text
```

--------------------------------

### Base Text Translation Example (JSON)

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/i18n/docs/README.md

An example of a JSON file containing translated base UI text for n8n. The keys represent UI elements (e.g., category names), and the values are the translated strings, prefixed with '🇩🇪' to indicate German translation.

```json
{
	"nodeCreator.categoryNames.analytics": "🇩🇪 Analytics",
	"nodeCreator.categoryNames.communication": "🇩🇪 Communication",
	"nodeCreator.categoryNames.coreNodes": "🇩🇪 Core Nodes"
}
```

--------------------------------

### Plaintext Handling

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/codemirror-lang/test/expressions/cases.txt

This snippet demonstrates how n8n processes plain text, including cases with single braces or combinations of braces that do not form valid resolvable expressions.

```n8n
text
```

```n8n
{text}
```

```n8n

```

```n8n
 
```

```n8n
{
```

```n8n
{ }}
```

--------------------------------

### Update Import Paths for Local Chat Bundle

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/nodes-langchain/nodes/trigger/ChatTrigger/README.md

Modifies the script and link tags in 'templates.ts' to use the locally served chat bundle and CSS file from the HTTPS server running on localhost:8443. This ensures the application loads the local development version.

```html
<script type="module">
    import { createChat } from 'https://127.0.0.1:8443/chat.bundle.es.js';

```

```html
<link href="https://127.0.0.1:8443/style.css" rel="stylesheet" />

```

--------------------------------

### Generate SSL Certificate using openssl

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/nodes-langchain/nodes/trigger/ChatTrigger/README.md

Generates a self-signed SSL certificate (key.pem and cert.pem) using openssl for enabling HTTPS connections during local development. This is necessary because the chat bundle is served via HTTPS.

```bash
openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes
```

--------------------------------

### Building Translations Command

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/i18n/docs/README.md

Shell commands to set the default locale to German and start the n8n development server for building translations.

```shell
export N8N_DEFAULT_LOCALE=de
pnpm start
```

```shell
export N8N_DEFAULT_LOCALE=de
cd packages/frontend/editor-ui
pnpm dev
```

--------------------------------

### n8n Initialization Output with Custom Locale

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/i18n/docs/README.md

This output shows the typical messages displayed when n8n initializes, including the version and the currently active locale, which has been set to 'de' in this example.

```text
Initializing n8n process
n8n ready on 0.0.0.0, port 5678
Version: 0.156.0
Locale: de

Editor is now accessible via:
http://localhost:5678/

Press "o" to open in Browser.
```

--------------------------------

### CLI Command Update for n8n

Source: https://github.com/kds2000a/n8n/blob/master/packages/cli/BREAKING-CHANGES.md

This snippet shows the necessary change in how to start n8n via its JavaScript file due to a CLI library update. The path to the index.js file has been changed to bin/n8n.

```shell
/usr/local/bin/node ./dist/index.js start
```

```shell
/usr/local/bin/node bin/n8n start
```

--------------------------------

### Update n8n using Docker Compose

Source: https://github.com/kds2000a/n8n/blob/master/docker/images/n8n/README.md

These commands update an n8n instance managed by Docker Compose. It pulls the latest image, stops and removes the old container, and then starts the new one.

```bash
# Pull latest version
docker compose pull

# Stop and remove older version
docker compose down

# Start the container
docker compose up -d
```

--------------------------------

### Resolvable with Nested and Escaped Braces

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/codemirror-lang/test/expressions/cases.txt

This snippet demonstrates n8n's ability to parse resolvable expressions with nested and escaped curly braces, including single, double, and triple brace scenarios.

```n8n
{{ he { llo }}
```

```n8n
{{ he {{ llo }}
```

```n8n
{{ he {{{ llo }}
```

```n8n
{{ he } llo }}
```

```n8n
{{ he \} llo }}
```

```n8n
{{ he \}} llo }}
```

```n8n
{{ he { abc } llo }}
```

```n8n
{{ he {{ abc \}} llo }}
```

```n8n
{{ he {{{ abc \}}} llo }}
```

--------------------------------

### N8N Chat Fullscreen Mode Setup

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/chat/README.md

To enable fullscreen mode for the n8n chat window, ensure that the target container element (often the html or body) has a defined width and height. This CSS snippet sets the width and height of html, body, and #n8n-chat to 100%.

```css
html,
body,
#n8n-chat {
	width: 100%;
	height: 100%;
}
```

--------------------------------

### Harvest Node: Move account field to parameters

Source: https://github.com/kds2000a/n8n/blob/master/packages/cli/BREAKING-CHANGES.md

The Harvest node now uses an 'Account ID' parameter instead of credential setup for account selection. This allows users to manage multiple accounts without creating duplicate credentials.

```n8n
Set the parameter `Account ID`.
```

--------------------------------

### Run Benchmark Suite Locally

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/benchmark/README.md

Initiates the n8n benchmark suite execution locally.

```sh
pnpm benchmark-locally
```

--------------------------------

### Build static Storybook pages

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/design-system/README.md

Builds static HTML pages for the Storybook documentation. This is useful for deploying or sharing the component library's documentation.

```shell
pnpm build:storybook
```

--------------------------------

### Run Benchmark Suite in Cloud

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/benchmark/README.md

Initiates the n8n benchmark suite execution in a cloud environment.

```sh
pnpm benchmark-in-cloud
```

--------------------------------

### Run Benchmark with Docker Image

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/benchmark/README.md

Execute benchmark scenarios using the n8n-benchmark Docker image. This command pulls the latest image, prints help, and runs all scenarios for 1 minute with 5 concurrent requests against a specified n8n instance.

```sh
docker pull ghcr.io/n8n-io/n8n-benchmark:latest
# Print the help to list all available flags
docker run ghcr.io/n8n-io/n8n-benchmark:latest run --help
# Run all available benchmark scenarios for 1 minute with 5 concurrent requests
docker run ghcr.io/n8n-io/n8n-benchmark:latest run \
	--n8nBaseUrl=https://instance.url \
	--n8nUserEmail=InstanceOwner@email.com \
	--n8nUserPassword=InstanceOwnerPassword \
	--vus=5 \
	--duration=1m \
	--scenarioFilter=single-webhook
```

--------------------------------

### Clone and Set Up n8n Repository

Source: https://github.com/kds2000a/n8n/blob/master/CONTRIBUTING.md

Commands to fork, clone the n8n repository, and set up the upstream remote for development.

```bash
git clone https://github.com/<your_github_username>/n8n.git
cd n8n
git remote add upstream https://github.com/n8n-io/n8n.git
```

--------------------------------

### Run Benchmark Locally with Docker

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/benchmark/README.md

Build and run the n8n-benchmark Docker image locally. This involves building the image, specifying the platform for compatibility, and then running the container with environment variables for n8n credentials and base URL.

```sh
# Must be run in the repository root
# k6 doesn't have an arm64 build available for linux, we need to build against amd64
docker build --platform linux/amd64 -t n8n-benchmark -f packages/@n8n/benchmark/Dockerfile .
docker run \
  -e N8N_USER_EMAIL=user@n8n.io \
  -e N8N_USER_PASSWORD=password \
  # For macos, n8n running outside docker
  -e N8N_BASE_URL=http://host.docker.internal:5678 \
  n8n-benchmark
```

--------------------------------

### JavaScript File Class Constructor and Methods

Source: https://github.com/kds2000a/n8n/blob/master/cypress/fixtures/Dummy_javascript.txt

Defines the File class, its static properties like 'list' and 'progress', and instance properties for URL and object. Includes static methods 'indexOf' and 'find' for searching within the file list, and prototype methods 'equals' for comparison and 'save' for adding/updating the file list.

```javascript
var File = function(url, object){
	File.list = Array.isArray(File.list)? File.list : [];
	File.progress = File.progress || 0;
	this.progress = 0;
	this.object = object;
	this.url = url;
};

File.indexOf = function(term){
	for(var index in File.list){
		var file = File.list[index];
		if (file.equals(term) || file.url === term || file.object === term) {
			return index;
		}
	}
	return -1;
};

File.find = function(term){
	var index = File.indexOf(term);
	return ~index && File.list[index];
};

File.prototype.equals = function(file){
	var isFileType = file instanceof File;
	return isFileType && this.url === file.url && this.object === file.object;
};

File.prototype.save = function(update){
	update = typeof update === 'undefined'? true : update;
	if(Array.isArray(File.list)){
		var index = File.indexOf(this);
		if(~index && update) {
			File.list[index] = this;
			console.warn('File `%s` has been loaded before and updated now for: %O.', this.url, this);
		}else File.list.push(this);
		console.log(File.list)
	}else{
		File.list = [this];
	}
	return this;
};
```

--------------------------------

### Create and Populate 'dept' Table (SQL)

Source: https://github.com/kds2000a/n8n/blob/master/cypress/fixtures/Dummy_sql.txt

Defines the 'dept' table structure with department number, name, and location. It then inserts 4 records into the table.

```SQL
CREATE TABLE dept (
deptno INT NOT NULL,
dname VARCHAR(14),
loc VARCHAR(13))
begin
insert into dept values (1,'ACCOUNTING','ST LOUIS')
insert into dept values (2,'RESEARCH','NEW YORK')
insert into dept values (3,'SALES','ATLANTA')
insert into dept values (4, 'OPERATIONS','SEATTLE')
end
```

--------------------------------

### Run unit tests

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/design-system/README.md

Executes the project's unit tests to ensure the components are functioning as expected. This command typically uses a testing framework like Jest.

```shell
pnpm test:unit
```

--------------------------------

### Create and Populate 'emp' Table (SQL)

Source: https://github.com/kds2000a/n8n/blob/master/cypress/fixtures/Dummy_sql.txt

Defines the 'emp' table structure with employee details including ID, name, job, salary, and department. It then inserts 14 records into the table.

```SQL
CREATE TABLE emp (
empno INT PRIMARY KEY,
ename VARCHAR(10),
job VARCHAR(9),
mgr INT NULL,
hiredate DATETIME,
sal NUMERIC(7,2),
comm NUMERIC(7,2) NULL,
dept INT)
begin
insert into emp values
    (1,'JOHNSON','ADMIN',6,'12-17-1990',18000,NULL,4)
insert into emp values
    (2,'HARDING','MANAGER',9,'02-02-1998',52000,300,3)
insert into emp values
    (3,'TAFT','SALES I',2,'01-02-1996',25000,500,3)
insert into emp values
    (4,'HOOVER','SALES I',2,'04-02-1990',27000,NULL,3)
insert into emp values
    (5,'LINCOLN','TECH',6,'06-23-1994',22500,1400,4)
insert into emp values
    (6,'GARFIELD','MANAGER',9,'05-01-1993',54000,NULL,4)
insert into emp values
    (7,'POLK','TECH',6,'09-22-1997',25000,NULL,4)
insert into emp values
    (8,'GRANT','ENGINEER',10,'03-30-1997',32000,NULL,2)
insert into emp values
    (9,'JACKSON','CEO',NULL,'01-01-1990',75000,NULL,4)
insert into emp values
    (10,'FILLMORE','MANAGER',9,'08-09-1994',56000,NULL,2)
insert into emp values
    (11,'ADAMS','ENGINEER',10,'03-15-1996',34000,NULL,2)
insert into emp values
    (12,'WASHINGTON','ADMIN',6,'04-16-1998',18000,NULL,4)
insert into emp values
    (13,'MONROE','ENGINEER',10,'12-03-2000',30000,NULL,2)
insert into emp values
    (14,'ROOSEVELT','CPA',9,'10-12-1995',35000,NULL,1)
end
```

--------------------------------

### n8n Node.js version requirement update

Source: https://github.com/kds2000a/n8n/blob/master/packages/cli/BREAKING-CHANGES.md

n8n now requires Node.js version 12.9 or newer. Users running older versions must upgrade their Node.js installation.

```shell
Node.js version 12.9 or newer is required to run n8n.
```

--------------------------------

### Build CSS theme files

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/design-system/README.md

Compiles the CSS theme files for the design system. This command processes SCSS or other preprocessors to generate the final CSS output.

```shell
pnpm build:theme
```

--------------------------------

### Credential Name Property for Translation File

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/i18n/docs/README.md

Example TypeScript code showing how the `name` property of an ICredentialType interface determines the filename for its corresponding translation file (e.g., 'githubApi.json').

```typescript
export class GithubApi implements ICredentialType {
	name = 'githubApi'; // to use for credential translation file
	displayName = 'Github API';
	documentationUrl = 'github';
	properties: INodeProperties[] = [

```

--------------------------------

### Prepare and Activate pnpm Version with Corepack

Source: https://github.com/kds2000a/n8n/blob/master/CONTRIBUTING.md

Prepares and activates a specific version of pnpm using Corepack, a prerequisite for n8n development.

```bash
corepack prepare --activate
```

--------------------------------

### Run n8n Tests and Manage Snapshots

Source: https://github.com/kds2000a/n8n/blob/master/CONTRIBUTING.md

Commands to execute the test suite and update snapshot files if changes are required.

```bash
pnpm test
pnpm test -u
```

--------------------------------

### n8n Chat Widget Configuration Options

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/chat/README.md

Provides a detailed look at the default configuration options available for the `createChat` function. This includes settings for webhook URLs, request methods, target elements, display modes, welcome screens, session management, and internationalization.

```ts
createChat({
	webhookUrl: '',
	webhookConfig: {
		method: 'POST',
		headers: {}
	},
	target: '#n8n-chat',
	mode: 'window',
	chatInputKey: 'chatInput',
	chatSessionKey: 'sessionId',
	loadPreviousSession: true,
	metadata: {},
	showWelcomeScreen: false,
	defaultLanguage: 'en',
	initialMessages: [
		'Hi there! 👋',
		'My name is Nathan. How can I assist you today?'
	],
	i18n: {
		en: {
			title: 'Hi there! 👋',
			subtitle: "Start a chat. We're here to help you 24/7.",
			footer: '',
			getStarted: 'New Conversation',
			inputPlaceholder: 'Type your question..',
		},
	},
});
```

--------------------------------

### Deploy n8n with Docker

Source: https://github.com/kds2000a/n8n/blob/master/README.md

Deploy n8n using Docker by creating a volume for data persistence and running the n8n container. Access the editor at http://localhost:5678.

```shell
docker volume create n8n_data
docker run -it --rm --name n8n -p 5678:5678 -v n8n_data:/home/node/.n8n docker.n8n.io/n8nio/n8n
```

--------------------------------

### Resolvable with Non-ASCII and Special Characters

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/codemirror-lang/test/expressions/cases.txt

This section showcases n8n's handling of resolvable expressions containing various non-ASCII characters, including accented letters, Cyrillic, CJK, pictographs, emoticons, and other special Unicode symbols.

```n8n
{{ 'áßи' }}
```

```n8n
{{ '€' }}
```

```n8n
{{ 'л' }}
```

```n8n
{{ '🎉' }}
```

```n8n
{{ '😎' }}
```

```n8n
{{ '†' }}
```

```n8n
{{ '⁷' }}
```

```n8n
{{ '漢' }}
```

```n8n
{{ '🟢' }}
```

```n8n
{{ '🫸' }}
```

```n8n
{{ '✀' }}
```

```n8n
{{ '➿' }}
```

--------------------------------

### DynamicTool Creation for Vector Store Operations

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/nodes-langchain/nodes/vector_store/shared/createVectorStoreNode/README.md

Illustrates how a `DynamicTool` is created for the 'retrieve-as-tool' mode, exposing vector store search functionality with a name, description, and a function to perform the search.

```javascript
const vectorStoreTool = new DynamicTool({
  name: toolName,
  description: toolDescription,
  func: async (input) => {
    // Search vector store with input
    // ...
  },
});
```

--------------------------------

### PostHog Analytics Initialization (JavaScript)

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/editor-ui/index.html

This snippet initializes the PostHog analytics library. It sets up the API host and associates events with the provided API key and configuration. It's designed to be included in web applications for tracking user behavior.

```javascript
!function(t,e){var o,n,p,r;e.__SV||(window.posthog=e,e._i=[],e.init=function(i,s,a){function g(t,e){var o=e.split(".");2==o.length&&(t=t[o[0]],e=o[1]),t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}}(p=t.createElement("script")).type="text/javascript",p.async=!0,p.src=s.api_host+"/static/array.js",(r=t.getElementsByTagName("script")[0]).parentNode.insertBefore(p,r);var u=e;void 0!==a?u=e[a]=[]:a="posthog",u.people=u.people||[],u.toString=function(t){var e="posthog";return"posthog"!==a&&(e+="."+a),t||(e+=" (stub)"),e},u.people.toString=function(){return u.toString(1)+".people (stub)"},o="capture identify alias people.set people.set_once set_config register register_once unregister opt_out_capturing has_opted_out_capturing opt_in_capturing reset isFeatureEnabled getFeatureFlag onFeatureFlags reloadFeatureFlags".split(" "),n=0;n<o.length;n++)g(u,o[n]);e._i.push([i,s,a])},e.__SV=1)}(document,window.posthog||[])
```

--------------------------------

### Create a Basic n8n Node in TypeScript

Source: https://github.com/kds2000a/n8n/blob/master/packages/node-dev/README.md

Defines a simple n8n node using TypeScript. It includes node description properties, such as display name, group, version, and user-configurable properties like 'myString'. The 'execute' method processes input data, adding the 'myString' value to each item.

```TypeScript
import {
	IExecuteFunctions,
	INodeExecutionData,
	INodeType,
	INodeTypeDescription,
} from 'n8n-workflow';


export class MyNode implements INodeType {
	description: INodeTypeDescription = {
		displayName: 'My Node',
		name: 'myNode',
		group: ['transform'],
		version: 1,
		description: 'Adds "myString" on all items to defined value.',
		defaults: {
			name: 'My Node',
			color: '#772244',
		},
		inputs: ['main'],
		outputs: ['main'],
		properties: [
			// Node properties which the user gets displayed and
			// can change on the node.
			{
				displayName: 'My String',
				name: 'myString',
				type: 'string',
				default: '',
				placeholder: 'Placeholder value',
				description: 'The description text',
			}
		]
	};


	aSync execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {

		const items = this.getInputData();

		let item: INodeExecutionData;
		let myString: string;

		// Itterates over all input items and add the key "myString" with the
		// value the parameter "myString" resolves to.
		// (This could be a different value for each item in case it contains an expression)
		for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
			myString = this.getNodeParameter('myString', itemIndex, '') as string;
			item = items[itemIndex];

			item.json['myString'] = myString;
		}

		return [items];

	}
}
```

--------------------------------

### Enable Corepack

Source: https://github.com/kds2000a/n8n/blob/master/CONTRIBUTING.md

Enables Node.js Corepack, a tool for managing package manager versions, recommended for n8n development.

```bash
corepack enable
```

--------------------------------

### Enable stdout for Code node logs in n8n (Environment Variable)

Source: https://github.com/kds2000a/n8n/blob/master/packages/cli/BREAKING-CHANGES.md

Starting from n8n version 1.5.0, `console.log` in the Code node does not output to stdout by default. To redirect Code node logs to the process's standard output, set the environment variable `CODE_ENABLE_STDOUT` to `true`. This is necessary if you rely on `console.log` for non-manual executions.

```shell
CODE_ENABLE_STDOUT=true
```

--------------------------------

### VectorStoreNodeConstructorArgs Interface

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/nodes-langchain/nodes/vector_store/shared/createVectorStoreNode/README.md

Defines the configuration and callbacks required for vector store implementations in n8n nodes. It includes metadata, optional methods for searches, fields specific to different operation modes (insert, load, retrieve, update), and core functions like `populateVectorStore` and `getVectorStoreClient`.

```typescript
interface VectorStoreNodeConstructorArgs<T extends VectorStore> {
  meta: NodeMeta;
  methods?: { ... };
  sharedFields: INodeProperties[];
  insertFields?: INodeProperties[];
  loadFields?: INodeProperties[];
  retrieveFields?: INodeProperties[];
  updateFields?: INodeProperties[];
  populateVectorStore: Function;
  getVectorStoreClient: Function;
  releaseVectorStoreClient?: Function;
}
```

--------------------------------

### Run n8n with PostgreSQL using Docker

Source: https://github.com/kds2000a/n8n/blob/master/docker/images/n8n/README.md

This command demonstrates how to run n8n using PostgreSQL as the database. It sets environment variables for PostgreSQL connection details and mounts a Docker volume for data persistence. Replace placeholders with your actual PostgreSQL credentials.

```bash
docker volume create n8n_data

docker run -it --rm \
 --name n8n \
 -p 5678:5678 \
 -e DB_TYPE=postgresdb \
 -e DB_POSTGRESDB_DATABASE=<POSTGRES_DATABASE> \
 -e DB_POSTGRESDB_HOST=<POSTGRES_HOST> \
 -e DB_POSTGRESDB_PORT=<POSTGRES_PORT> \
 -e DB_POSTGRESDB_USER=<POSTGRES_USER> \
 -e DB_POSTGRESDB_SCHEMA=<POSTGRES_SCHEMA> \
 -e DB_POSTGRESDB_PASSWORD=<POSTGRES_PASSWORD> \
 -v n8n_data:/home/node/.n8n \
 docker.n8n.io/n8nio/n8n
```

--------------------------------

### Enable Local Code Coverage

Source: https://github.com/kds2000a/n8n/blob/master/CONTRIBUTING.md

Environment variable to enable code coverage reporting when running tests locally.

```bash
COVERAGE_ENABLED=true pnpm test
```

--------------------------------

### Run Debug Flaky E2E Tests

Source: https://github.com/kds2000a/n8n/blob/master/cypress/README.md

Executes flaky end-to-end tests with optional filtering and burn count. Uses pnpm as the package manager.

```bash
pnpm run debug:flaky:e2e -- <grep_filter> <burn_count>
```

```bash
pnpm run debug:flaky:e2e CAT-726 10
```

```bash
pnpm run debug:flaky:e2e login
```

```bash
pnpm run debug:flaky:e2e
```

--------------------------------

### Monitor theme files for changes and rebuild

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/design-system/README.md

Watches the theme files for any modifications and automatically rebuilds the CSS theme whenever changes are detected. This streamlines the theming development process.

```shell
pnpm watch:theme
```

--------------------------------

### Resource Cleanup with finally Block

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/nodes-langchain/nodes/vector_store/shared/createVectorStoreNode/README.md

Demonstrates robust error handling and resource management by using a `finally` block to ensure the `releaseVectorStoreClient` function is always called, even if errors occur during the operation. This is crucial for preventing resource leaks.

```javascript
try {
  // Operation logic
} finally {
  args.releaseVectorStoreClient?.(vectorStore);
}
```

--------------------------------

### Lint and fix files

Source: https://github.com/kds2000a/n8n/blob/master/packages/frontend/@n8n/design-system/README.md

Applies linting rules to the project files and automatically fixes any style or syntax violations. This helps maintain code quality and consistency.

```shell
pnpm lint
```

--------------------------------

### Operation Handlers for Vector Store Nodes

Source: https://github.com/kds2000a/n8n/blob/master/packages/@n8n/nodes-langchain/nodes/vector_store/shared/createVectorStoreNode/README.md

Illustrates the function signatures for operation handlers in vector store nodes. These handlers manage specific operations like loading and inserting documents, taking context, arguments, embeddings, and item index as input.

```typescript
// Example: loadOperation.ts
export async function handleLoadOperation<T extends VectorStore>(
  context: IExecuteFunctions,
  args: VectorStoreNodeConstructorArgs<T>,
  embeddings: Embeddings,
  itemIndex: number
): Promise<INodeExecutionData[]>
```

```typescript
// Example: insertOperation.ts (v1.1+)
export async function handleInsertOperation<T extends VectorStore>(
  context: IExecuteFunctions,
  args: VectorStoreNodeConstructorArgs<T>,
  embeddings: Embeddings
): Promise<INodeExecutionData[]>
```

--------------------------------

### Build n8n Docker image with specific version

Source: https://github.com/kds2000a/n8n/blob/master/docker/images/n8n/README.md

This command builds a custom n8n Docker image for multiple platforms (amd64 and arm64) with a specified n8n version. Replace '<VERSION>' with the desired version number.

```bash
docker buildx build --platform linux/amd64,linux/arm64 --build-arg N8N_VERSION=<VERSION> -t n8n:<VERSION> .

# For example:
docker buildx build --platform linux/amd64,linux/arm64 --build-arg N8N_VERSION=1.30.1 -t n8n:1.30.1 .
```