Index of every page on this site: llms.txt
All skills
n8n-io avatar

/nathan

@273d130 official
by n8n - Workflow Automationn8n-io/n8n211k stars
61,599
Run it yourself

Deploy a temporary n8n test instance (or generate a local docker run command) via the internal "Nathan" bot, from the repo instead of Slack. Use after opening a PR to offer the user a live test instance, or whenever someone asks to spin up / deploy a test instance for a branch.

  • 1 file
  • 5.6 KB
  • Updated 2 months ago
  • GitHub
Use this Skill: https://skilld.dev/gh/n8n-io/n8n/nathan

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈72 tokens for metadata: the name and description. ≈1.3k when used: this file.

Description uses 3.6% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈291 characters, or 3.6%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Nathan — repo-local test instances

Nathan is n8n's internal bot that deploys throwaway test instances from a branch or Docker image. It's normally driven from Slack (/nathan ...); this skill runs the same commands from the repo via pnpm nathan.

Prerequisites

  • No tunnel setup needed. Nathan replies asynchronously through a short-lived Cloudflare Quick Tunnel that the script opens for you (npx cloudflared). A deploy to a new test-<name> also polls that instance URL directly, so it still reports success even if the tunnel drops. (Redeploying a name that's already up skips the poll — it can't tell the old instance from the new — so it falls back to the tunnel; prefer a fresh name when you need the reliable report.)

  • A token in ~/.n8n/dev/nathan-token. If a command reports no token, ask the user for one — point them at the form (https://internal.users.n8n.cloud/form/d6d34a2f-4899-4ee8-afc8-f8c41a8a243d), where they log in with their n8n account and copy the token from the response — then save it for them (the script's interactive paste prompt needs a real terminal, so as an agent use the subcommand):

    pnpm nathan set-token '<PASTED_TOKEN>'

Offer a test instance

Only when it's worth it

Use judgement — don't offer for every branch. Offer when the change is something a person would actually want to click through in a running instance:

  • New features / feature branches
  • UI / editor changes, node changes, workflow-execution or behaviour changes
  • Larger or user-facing diffs

Skip the offer (a test instance adds nothing) for:

  • Dev tooling, CI, build config, scripts (like this one)
  • Docs-only or tests-only changes
  • Tiny bug fixes, no-behaviour-change refactors, dependency bumps

When skipping, don't nag — at most mention once that a test instance is available on request.

Offer after opening a PR, and re-offer on push

After you open a PR for a branch that warrants it, offer a live test instance. Also re-offer whenever you git push new commits to such a branch — the deployed instance reflects the pushed code, so a new push means a new build worth redeploying. Don't just ask a bare yes/no — look at the diff and propose a sensible profile, then let them confirm or adjust. For example:

"Want a test instance for this? Based on the diff I'd deploy it with instance AI enabled (--ai) since it touches the AI assistant. Sound good, or a different license?"

Pick the profile from the PR contents

Inspect what the PR changes (git diff --stat origin/master...HEAD and the file paths / feature area), then choose:

PR touches… Suggest Why
AI features — @n8n/nodes-langchain, @n8n/instance-ai, the AI assistant/builder, N8N_AI_*, "askAi"/agent code --ai Enables instance AI (and defaults the license to pro2) so the AI features actually run
License-gated / enterprise features — .ee.ts files or /ee/ dirs, license checks (@n8n_io/license-sdk, hasFeature), SSO/SAML/OIDC/LDAP, RBAC/roles/scopes, projects, variables, external secrets, source control/environments, log streaming, insights, folders --enterprise The feature is gated behind a license and won't be testable on community
A specific gated feature/quota you want on/off --license pro2 --featureOverride <featureKey>:<value> Bakes the override into a generated license (community/enterprise can't be overridden)
Anything else — core nodes, generic UI, non-gated bug fixes (nothing — community default) No license needed

If both AI and enterprise apply, combine them: --ai --enterprise. When unsure, state your best guess and ask. Run pnpm nathan help for the full flag reference.

Deploy

pnpm nathan deploy <branch-name> test-<short-name> [flags]

Nathan builds the branch image (a few minutes) and the command prints the instance URL (https://test-<short-name>.stage-app.n8n.cloud, login test@n8n.io / helloWorld7). Relay that URL to the user.

Common commands

pnpm nathan help                                   # full option reference
pnpm nathan deploy my-branch test-my-feature       # community license
pnpm nathan deploy my-branch test-sso --enterprise # enterprise license
pnpm nathan deploy my-branch test-ai --ai          # instance AI (license -> pro2)
pnpm nathan deploy nightly test-nightly            # deploy the n8nio/n8n:nightly image

Key flags (after the deploy args): --license community|enterprise|starter|pro1|pro2|trial, --enterprise, --ai, -e KEY=value (repeatable), --featureOverride key:value (needs a generated license).

local caveat

pnpm nathan local ... generates a runnable docker run bundle, but Nathan delivers it as Slack file attachments (run-n8n.sh + .env), not to the terminal — they land in #updates-pnpm-nathan (https://n8nio.slack.com/archives/C0BGVHZ0SCW). deploy and help return fully in the terminal.

Do not invent a NATHAN_SLACK_CHANNEL. Leave it unset (it defaults to #updates-pnpm-nathan); only set it if the user explicitly gives you a channel id.

Unsupported

Queue mode, multi-main, and non-SQLite databases are not supported by Nathan.

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No third-party reports yet.

Signed by skilld at 273d130. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 2 months ago
What it can do
Runs commands Reads files
All 4 allowed tools
Bash(pnpm nathan:*)Bash(node scripts/nathan.mjs:*)Bash(git diff:*)Read

README badge

README badge for n8n-io/n8n/nathan