n8nac Cheat-Sheet
Source-of-truth for "what command do I run for X?" If your task matches a row, run the exact command shown — do not paraphrase, do not invent flags, do not run --help. If no row matches, fall back to n8nac-reference for the full help tree.
All commands below assumenpx n8nac …and a workspace bound to an n8n instance (workspace status: bound). Replace<id>,<name>,<path>with concrete values.
Workspace & Setup
| User intent | Command | |---|---| | First-time setup (connect to existing n8n) | npx n8nac env add <name> --base-url "$N8N_API_URL" --workflows-path workflows then printf "%s" "$N8N_API_KEY" \| npx n8nac env auth set <name> --api-key-stdin then npx n8nac env use <name> | | List supported setup modes | npx n8nac setup-modes | | Show effective workspace context (active project, instance, sync folder) | npx n8nac workspace status --json | | Bind instance + set sync folder (new env) | npx n8nac env add <name> --base-url <url> --workflows-path workflows | | Switch active project on an environment | npx n8nac env update <env> --project-name "<name>" or --project-id "<id>" | | Set workflow sync folder on an existing env | npx n8nac env update <env> --workflows-path <relativePath> |
Multi-Environment (multiple n8n instances per repo)
| User intent | Command | |---|---| | List configured environments | npx n8nac env list --json | | Show active environment + auth state | npx n8nac env status --json | | Add a new environment | npx n8nac env add <name> --base-url <url> --workflows-path workflows | | Switch active environment | npx n8nac env use <name> (alias: env pin) | | Store API key for an environment | printf "%s" "$N8N_API_KEY" \| npx n8nac env auth set <name> --api-key-stdin | | Update any env property (URL / project / sync folder / name) | npx n8nac env update <name-or-id> --base-url <url> (swap flag as needed) | | Target one command at a non-active env | npx n8nac --env <name> <command> (root flag) |
Workflows — Local & Remote Lifecycle
| User intent | Command | |---|---| | List all workflows (local + remote, excluding archived) | npx n8nac list --json | | List including archived | npx n8nac list --include-archived --json | | List archived only | npx n8nac list --only-archived --json | | Filter by search term | npx n8nac list --search "<query>" --json | | Search by partial name / ID / filename | npx n8nac find "<query>" --json | | Search remote only | npx n8nac find "<query>" --json --remote | | Download a single workflow from n8n | npx n8nac pull <workflowId> | | Refresh internal cache for one workflow (no file write) | npx n8nac fetch <workflowId> | | Upload a single workflow | npx n8nac push <path> | | Upload + verify remote after push (preferred) | npx n8nac push <path> --verify | | Validate remote workflow against local schema | npx n8nac verify <workflowId> | | Resolve a local/remote conflict — remote wins | npx n8nac pull <workflowId> | | Resolve a conflict — local wins (BLOCKED by push-gate) | N8N_AUTOPILOT_ALLOW_LOCAL_WINS=1 npx n8nac resolve <id> --mode keep-current | | Resolve interactively | npx n8nac resolve <id> | | Activate a workflow on the remote | npx n8nac workflow activate <id> | | Deactivate a workflow | npx n8nac workflow deactivate <id> | | Resolve the canonical UI URL | npx n8nac workflow present <id> --json | | Check whether all credentials are present for a workflow | npx n8nac workflow credential-required <id> (exit 0 = OK, exit 1 = missing) | | Promote a workflow from env A to env B | npx n8nac promote <path> --from <envA> --to <envB> | | Convert local file JSON ↔ TypeScript | npx n8nac convert <file> | | Batch convert a directory | npx n8nac convert-batch <directory> | | Regenerate AGENTS.md + AI context | npx n8nac update-ai |
Testing & Execution
| User intent | Command | |---|---| | Infer trigger type + payload before testing | npx n8nac test-plan <id> --json | | Test webhook/chat/form (POST body) | npx n8nac test <id> --data '<json>' | | Test webhook (GET query string) | npx n8nac test <id> --query '<json>' | | Test against production URL (workflow must be active) | npx n8nac test <id> --prod --data '<json>' | | List recent executions for a workflow | npx n8nac execution list --workflow-id <id> --limit 10 | | Get one execution's full I/O | npx n8nac execution get <executionId> --include-data | | Get one execution's metadata only | npx n8nac execution get <executionId> |
Credentials (direct CRUD)
| User intent | Command | |---|---| | List all credentials (metadata, no secrets) | npx n8nac credential list --json | | Get one credential's metadata | npx n8nac credential get <id> | | Show JSON schema for a credential type | npx n8nac credential schema <type> | | Create a credential | npx n8nac credential create --type <type> --name "<name>" --file cred.json | | Delete a credential | npx n8nac credential delete <id> |
For project-aware credential lookup, use/n8n-autopilot:find-credential(default = active project, no cross-project leak). Usecredential listdirectly only when you need raw shape.
Credentials (recipes / readiness)
| User intent | Command | |---|---| | List available credential recipes (openai-native, slack-oauth, postgres, …) | npx n8nac credentials recipes --json | | List the local credential inventory (which recipes are satisfied?) | npx n8nac credentials inventory --json | | Create a credential from a recipe | npx n8nac credentials ensure <recipeId> | | Test that a credential works against the live service | npx n8nac credentials test <id-or-recipeId> | | List bundled starter-kits | npx n8nac credentials starter-kits | | Apply a starter-kit | npx n8nac credentials starter-kit <kitId> | | Delete a credential via the recipe surface | npx n8nac credentials delete <id> |
Schemas, Node Info, Authoring Help
| User intent | Command | |---|---| | Search nodes by service / keyword | npx n8nac skills search "<query>" --json | | Get exact TypeScript snippet for one node | npx n8nac skills node-schema <type> --json | | Get full node info (params, credentials, typeVersion) | npx n8nac skills node-info <type> --json | | Find related/alternative nodes | npx n8nac skills related "<query>" --json | | Search community workflow examples (7000+ templates) | npx n8nac skills examples search "<query>" --json | | Get details for one example | npx n8nac skills examples info <id> | | Download an example as starting point | npx n8nac skills examples download <id> | | Search docs / guides | npx n8nac skills docs "<query>" / npx n8nac skills guides "<query>" | | Validate a .workflow.ts locally | npx n8nac skills validate <path> --strict --json | | Refresh AI context (AGENTS.md etc.) via skills facade | npx n8nac skills update-ai | | Launch n8nac's bundled MCP server (experimental) | npx n8nac skills mcp |
Native n8n MCP assist (ab n8nac 2.4 — read-only Broker gegen den Instanz-MCP)
| User intent | Command | |---|---| | Native MCP assist für ein Env konfigurieren (Token aus n8n UI → Settings → MCP) | npx n8nac native-mcp configure <env> --token-stdin (URL wird aus Env-Base-URL abgeleitet) | | Verbindung/Konfiguration prüfen | npx n8nac native-mcp doctor <env> --json | | Welche nativen Tools exposed die Instanz? | npx n8nac native-mcp tools <env> --json | | Assist-Status inkl. Tools | npx n8nac native-mcp status <env> --include-tools --json | | Assist abschalten | npx n8nac native-mcp disable <env> |
Wrapper sind read-only (Discovery, Execution-Inspektion, Server-side Validation). Authoring bleibt
.workflow.ts+push; Live-Tests bleibenn8nac test; Binär-Payloads NIE via MCP. Details +
Test-Pfad-Evaluation: docs/MCP.md.
Telemetry
| User intent | Command | |---|---| | Enable / disable / status anonymous telemetry | npx n8nac telemetry --help (small surface — read