n8nctl workflows
n8nctl workflows¶
Manage workflows
Synopsis¶
Create, list, inspect, update, delete, activate and transfer n8n workflows.
Create from a JSON file exported by n8n: n8nctl workflows create --file workflow.json A workflow body requires name, nodes, connections and settings.
Options¶
-h, --help help for workflows
Options inherited from parent commands¶
--api-key string override the API key (prefer keyring via 'auth login')
--base-url string override the instance base URL (e.g. https://host/api/v1)
--columns strings comma-separated columns for table/csv output
--dry-run print the equivalent curl and send no request
--jq string apply a jq program to the result (e.g. '.[].id'); implies JSON input
--no-color disable colored output [env: NO_COLOR]
--no-header hide the table header row
-o, --output string output format: table|json|yaml|csv [env: N8NCTL_OUTPUT]
--profile string config profile (instance) to use [env: N8NCTL_PROFILE]
-q, --quiet suppress non-essential chatter
--rps float client-side rate limit in requests/sec (0 = use config/default)
--show-token do not redact the API key in --dry-run output
-v, --verbose verbose (debug) logging to stderr
SEE ALSO¶
- n8nctl - Control any n8n instance from the terminal via its public API
- n8nctl workflows activate - Activate a workflow
- n8nctl workflows apply - Reconcile a directory of workflow files into the instance (GitOps)
- n8nctl workflows archive - Archive a workflow
- n8nctl workflows convert - Convert workflow files between JSON and YAML (local)
- n8nctl workflows create - Create a workflow
- n8nctl workflows deactivate - Deactivate a workflow
- n8nctl workflows delete - Delete a workflow
- n8nctl workflows diff - Diff a workflow against another instance or a local file
- n8nctl workflows get - Get a single workflow by id
- n8nctl workflows lint - Lint workflow definitions for common mistakes
- n8nctl workflows list - List workflows
- n8nctl workflows search - Find workflows by node type, credential, webhook path, or name
- n8nctl workflows sync - Promote a workflow to another instance (profile)
- n8nctl workflows tags - Get or replace a workflow's tags
- n8nctl workflows transfer - Transfer a workflow to another project
- n8nctl workflows unarchive - Restore an archived workflow
- n8nctl workflows update - Update a workflow