Repository intelligenceRepositories
⌘K
Home / Repositories / n8n-io/n8n / Instruction Manual
Instruction Manual · Apple silicon · macOS Tahoe

n8n-io/n8n Instruction Manual

Source-available visual workflow/AI-agent platform with a large connector ecosystem, templates, custom JavaScript/Python, self-hosting, and cloud.

Beginner-friendlyCopy-paste examplesFirst-party sources checked
GitHubRepository profileInstallation Guide

What n8n-io/n8n is—in plain language

Source-available visual workflow/AI-agent platform with a large connector ecosystem, templates, custom JavaScript/Python, self-hosting, and cloud.

Mental model: This repository behaves like a service or multi-process application. One command starts it, a browser/API/agent connects to it, and the Terminal process must remain running until you stop it.
Interfacesweb app, workflow engine, API
Primary languageTypeScript, JavaScript
Typical useAutomate SaaS, data, business, and AI workflows using a visual canvas, code nodes, human approvals, and many integrations.

Your first 15 minutes

  1. Complete the linked Installation Guide and its verification step.
  2. Create a disposable test folder or use non-sensitive sample data.
  3. Run the small example below and observe what files, ports, or prompts appear.
  4. Read the result before approving writes, network calls, account access, or costs.
  5. Only then repeat the workflow with a real project.
Starter workflow
npx n8n
# Then open http://localhost:5678
Open Installation GuideOpen upstream README

Complete indexed functionality map

Each card below corresponds to a component identified in the repository research. Open a component record for its path, purpose, capabilities, dependencies, risks, and relationships.

Upstream feature-by-feature guide

These capabilities are derived from the current first-party README and supporting documentation. Names follow upstream terminology so you can search the source documentation precisely.

Upstream capability

Key Capabilities

Upstream treats this as a distinct part of n8n-io/n8n. In plain language, use this area when your task concerns key capabilities. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

Upstream capability

Resources

Upstream treats this as a distinct part of n8n-io/n8n. In plain language, use this area when your task concerns resources. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

Upstream capability

Join the Team

Upstream treats this as a distinct part of n8n-io/n8n. In plain language, use this area when your task concerns join the team. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

Upstream capability

What does n8n mean?

Upstream treats this as a distinct part of n8n-io/n8n. In plain language, use this area when your task concerns what does n8n mean?. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

How to use the main workflows

1

Choose the smallest relevant function

Start with one capability card instead of asking the repository to do everything at once. This makes permissions, inputs, and output easier to understand.

2

Prepare a disposable input

Use a sample URL, copied repository, test document, or sandbox account. Keep production credentials and irreplaceable files out of the first run.

3

Run, observe, and stop

Watch Terminal output or the host application's activity view. If the behavior differs from the README, stop with Control + C or cancel inside the host before retrying.

4

Inspect the result

Check generated files, diffs, API responses, logs, or previews. Never assume “command finished” means the result is correct.

5

Save a repeatable recipe

Record the working command and non-secret configuration in your project's README. Store secrets in the documented environment file or password manager.

Copy-paste recipes from upstream documentation

These examples are selected from the repository's first-party documentation. Replace obvious placeholders, keep quotation marks intact, and run them only in the context indicated by the surrounding explanation.

Quick Start
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

Configuration, accounts, and files

Configuration files

None documented

A configuration file changes behavior without changing source code. Make one change at a time and keep a backup before editing JSON, TOML, YAML, or environment files.

Important directories

None documented

Paths identify where the relevant implementation or generated files live. Paths beginning with ~ are inside your home folder.

Credentials

connected-service credentials

Prefer temporary, least-privileged credentials. Never commit .env, tokens, cookies, private keys, or session exports.

External services

many third-party SaaS

Check pricing, data retention, rate limits, and account permissions before enabling optional integrations.

Safe operating habits

  • Use test data first and keep a current backup or Git commit.
  • Read commands before pasting. A README is useful evidence, not a substitute for judgment.
  • Review agent-generated file changes with git diff before committing.
  • Keep local services bound to 127.0.0.1 unless you intentionally secure and expose them.
  • Do not give plugins or MCP servers broader filesystem, browser, GitHub, or cloud access than their current task requires.
  • Confirm API costs and model names before running large batches.
  • Stop and investigate repeated authentication failures instead of pasting a token into multiple places.

Reference and source trail

The manual reflects first-party files checked on August 18, 2026. It explains the indexed repository rather than promising that every optional third-party integration is available or safe.