n8n:nathan

Source excerpt starting at line 1.

1---2name: n8n:nathan3description: 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.4allowed-tools: Bash(pnpm nathan:*), Bash(node scripts/nathan.mjs:*), Bash(git diff:*), Read5---6 7# Nathan — repo-local test instances8 9Nathan is n8n's internal bot that deploys throwaway test instances from a branch10or Docker image. It's normally driven from Slack (`/nathan ...`); this skill runs11the same commands from the repo via `pnpm nathan`.12 13## Prerequisites14 15- **No tunnel setup needed.** Nathan replies asynchronously through a short-lived16  public tunnel that the script opens for you (`npx localtunnel`). A `deploy` to a17  **new** `test-<name>` also polls that instance URL directly, so it still reports18  success even if the tunnel drops. (Redeploying a name that's *already up* skips19  the poll — it can't tell the old instance from the new — so it falls back to the20  tunnel; prefer a fresh name when you need the reliable report.)21- **A token in `~/.n8n/dev/nathan-token`.** If a command reports no token, **ask the22  user for one** — point them at the form23  (`https://internal.users.n8n.cloud/form/d6d34a2f-4899-4ee8-afc8-f8c41a8a243d`),24  where they log in with their n8n account and copy the token from the response —25  then save it for them (the script's interactive paste prompt needs a real26  terminal, so as an agent use the subcommand):27 28  ```bash29  pnpm nathan set-token '<PASTED_TOKEN>'30  ```31 32## Offer a test instance33 34### Only when it's worth it35 36Use judgement — don't offer for every branch. **Offer** when the change is37something a person would actually want to click through in a running instance:38 39- New features / feature branches40- UI / editor changes, node changes, workflow-execution or behaviour changes41- Larger or user-facing diffs42 43**Skip the offer** (a test instance adds nothing) for:44 45- Dev tooling, CI, build config, scripts (like this one)46- Docs-only or tests-only changes47- Tiny bug fixes, no-behaviour-change refactors, dependency bumps48 49When skipping, don't nag — at most mention once that a test instance is available50on request.51 52### Offer after opening a PR, and re-offer on push53 54After you open a PR for a branch that warrants it, **offer a live test instance.**55Also **re-offer whenever you `git push` new commits** to such a branch — the56deployed instance reflects the pushed code, so a new push means a new build worth57redeploying. Don't just ask a bare yes/no — look at the diff and **propose a58sensible profile**, then let them confirm or adjust. For example:59 60> "Want a test instance for this? Based on the diff I'd deploy it with instance AI61> enabled (`--ai`) since it touches the AI assistant. Sound good, or a different62> license?"63 64### Pick the profile from the PR contents65 66Inspect what the PR changes (`git diff --stat origin/master...HEAD` and the file67paths / feature area), then choose:68 69| PR touches… | Suggest | Why |70|---|---|---|71| 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 |72| 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 |73| 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) |74| Anything else — core nodes, generic UI, non-gated bug fixes | *(nothing — community default)* | No license needed |75 76If both AI and enterprise apply, combine them: `--ai --enterprise`. When unsure,77state your best guess and ask. Run `pnpm nathan help` for the full flag reference.78 79### Deploy80 81```bash82pnpm nathan deploy <branch-name> test-<short-name> [flags]83```84 85Nathan builds the branch image (a few minutes) and the command prints the instance86URL (`https://test-<short-name>.stage-app.n8n.cloud`, login `test@n8n.io` /87`helloWorld7`). Relay that URL to the user.88 89## Common commands90 91```bash92pnpm nathan help                                   # full option reference93pnpm nathan deploy my-branch test-my-feature       # community license94pnpm nathan deploy my-branch test-sso --enterprise # enterprise license95pnpm nathan deploy my-branch test-ai --ai          # instance AI (license -> pro2)96pnpm nathan deploy nightly test-nightly            # deploy the n8nio/n8n:nightly image97```98 99Key flags (after the deploy args): `--license community|enterprise|starter|pro1|pro2|trial`,100`--enterprise`, `--ai`, `-e KEY=value` (repeatable), `--featureOverride key:value`101(needs a generated license).102 103## `local` caveat104 105`pnpm nathan local ...` generates a runnable `docker run` bundle, but Nathan106delivers it as **Slack file attachments** (`run-n8n.sh` + `.env`), not to the107terminal — they land in **#updates-pnpm-nathan**108(https://n8nio.slack.com/archives/C0BGVHZ0SCW). `deploy` and `help` return fully109in the terminal.110 111**Do not invent a `NATHAN_SLACK_CHANNEL`.** Leave it unset (it defaults to112#updates-pnpm-nathan); only set it if the user explicitly gives you a channel id.113 114## Unsupported115 116Queue mode, multi-main, and non-SQLite databases are not supported by Nathan.117