n8n/oclif.manifest.json

n8n Workflow Automation Tool

{"version":"0.152.0","commands":{"execute":{"id":"execute","description":"\nExecutes a given workflow","pluginName":"n8n","pluginType":"core","aliases":[],"examples":["$ n8n execute --id=5","$ n8n execute --file=workflow.json"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"file":{"name":"file","type":"option","description":"path to a workflow file to execute"},"id":{"name":"id","type":"option","description":"id of the workflow to execute"},"rawOutput":{"name":"rawOutput","type":"boolean","description":"Outputs only JSON data, with no other text","allowNo":false}},"args":[]},"executeBatch":{"id":"executeBatch","description":"\nExecutes multiple workflows once","pluginName":"n8n","pluginType":"core","aliases":[],"examples":["$ n8n executeBatch","$ n8n executeBatch --concurrency=10 --skipList=/data/skipList.txt","$ n8n executeBatch --debug --output=/data/output.json","$ n8n executeBatch --ids=10,13,15 --shortOutput","$ n8n executeBatch --snapshot=/data/snapshots --shallow","$ n8n executeBatch --compare=/data/previousExecutionData --retries=2"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"debug":{"name":"debug","type":"boolean","description":"Toggles on displaying all errors and debug messages.","allowNo":false},"ids":{"name":"ids","type":"option","description":"Specifies workflow IDs to get executed, separated by a comma."},"concurrency":{"name":"concurrency","type":"option","description":"How many workflows can run in parallel. Defaults to 1 which means no concurrency.","default":1},"output":{"name":"output","type":"option","description":"Enable execution saving, You must inform an existing folder to save execution via this param"},"snapshot":{"name":"snapshot","type":"option","description":"Enables snapshot saving. You must inform an existing folder to save snapshots via this param."},"compare":{"name":"compare","type":"option","description":"Compares current execution with an existing snapshot. You must inform an existing folder where the snapshots are saved."},"shallow":{"name":"shallow","type":"boolean","description":"Compares only if attributes output from node are the same, with no regards to neste JSON objects.","allowNo":false},"skipList":{"name":"skipList","type":"option","description":"File containing a comma separated list of workflow IDs to skip."},"retries":{"name":"retries","type":"option","description":"Retries failed workflows up to N tries. Default is 1. Set 0 to disable.","default":1},"shortOutput":{"name":"shortOutput","type":"boolean","description":"Omits the full execution information from output, displaying only summary.","allowNo":false}},"args":[]},"start":{"id":"start","description":"Starts n8n. Makes Web-UI available and starts active workflows","pluginName":"n8n","pluginType":"core","aliases":[],"examples":["$ n8n start","$ n8n start --tunnel","$ n8n start -o","$ n8n start --tunnel -o"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"open":{"name":"open","type":"boolean","char":"o","description":"opens the UI automatically in browser","allowNo":false},"tunnel":{"name":"tunnel","type":"boolean","description":"runs the webhooks via a hooks.n8n.cloud tunnel server. Use only for testing and development!","allowNo":false}},"args":[]},"webhook":{"id":"webhook","description":"Starts n8n webhook process. Intercepts only production URLs.","pluginName":"n8n","pluginType":"core","aliases":[],"examples":["$ n8n webhook"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"worker":{"id":"worker","description":"\nStarts a n8n worker","pluginName":"n8n","pluginType":"core","aliases":[],"examples":["$ n8n worker --concurrency=5"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"concurrency":{"name":"concurrency","type":"option","description":"How many jobs can run in parallel.","default":10}},"args":[]},"db:revert":{"id":"db:revert","description":"Revert last database migration","pluginName":"n8n","pluginType":"core","aliases":[],"examples":["$ n8n db:revert"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"export:credentials":{"id":"export:credentials","description":"Export credentials","pluginName":"n8n","pluginType":"core","aliases":[],"examples":["$ n8n export:credentials --all","$ n8n export:credentials --id=5 --output=file.json","$ n8n export:credentials --all --output=backups/latest.json","$ n8n export:credentials --backup --output=backups/latest/","$ n8n export:credentials --all --decrypted --output=backups/decrypted.json"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"all":{"name":"all","type":"boolean","description":"Export all credentials","allowNo":false},"backup":{"name":"backup","type":"boolean","description":"Sets --all --pretty --separate for simple backups. Only --output has to be set additionally.","allowNo":false},"id":{"name":"id","type":"option","description":"The ID of the credential to export"},"output":{"name":"output","type":"option","char":"o","description":"Output file name or directory if using separate files"},"pretty":{"name":"pretty","type":"boolean","description":"Format the output in an easier to read fashion","allowNo":false},"separate":{"name":"separate","type":"boolean","description":"Exports one file per credential (useful for versioning). Must inform a directory via --output.","allowNo":false},"decrypted":{"name":"decrypted","type":"boolean","description":"Exports data decrypted / in plain text. ALL SENSITIVE INFORMATION WILL BE VISIBLE IN THE FILES. Use to migrate from a installation to another that have a different secret key (in the config file).","allowNo":false}},"args":[]},"export:workflow":{"id":"export:workflow","description":"Export workflows","pluginName":"n8n","pluginType":"core","aliases":[],"examples":["$ n8n export:workflow --all","$ n8n export:workflow --id=5 --output=file.json","$ n8n export:workflow --all --output=backups/latest/","$ n8n export:workflow --backup --output=backups/latest/"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"all":{"name":"all","type":"boolean","description":"Export all workflows","allowNo":false},"backup":{"name":"backup","type":"boolean","description":"Sets --all --pretty --separate for simple backups. Only --output has to be set additionally.","allowNo":false},"id":{"name":"id","type":"option","description":"The ID of the workflow to export"},"output":{"name":"output","type":"option","char":"o","description":"Output file name or directory if using separate files"},"pretty":{"name":"pretty","type":"boolean","description":"Format the output in an easier to read fashion","allowNo":false},"separate":{"name":"separate","type":"boolean","description":"Exports one file per workflow (useful for versioning). Must inform a directory via --output.","allowNo":false}},"args":[]},"import:credentials":{"id":"import:credentials","description":"Import credentials","pluginName":"n8n","pluginType":"core","aliases":[],"examples":["$ n8n import:credentials --input=file.json","$ n8n import:credentials --separate --input=backups/latest/"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"input":{"name":"input","type":"option","char":"i","description":"Input file name or directory if --separate is used"},"separate":{"name":"separate","type":"boolean","description":"Imports *.json files from directory provided by --input","allowNo":false}},"args":[]},"import:workflow":{"id":"import:workflow","description":"Import workflows","pluginName":"n8n","pluginType":"core","aliases":[],"examples":["$ n8n import:workflow --input=file.json","$ n8n import:workflow --separate --input=backups/latest/"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"input":{"name":"input","type":"option","char":"i","description":"Input file name or directory if --separate is used"},"separate":{"name":"separate","type":"boolean","description":"Imports *.json files from directory provided by --input","allowNo":false}},"args":[]},"list:workflow":{"id":"list:workflow","description":"\nList workflows","pluginName":"n8n","pluginType":"core","aliases":[],"examples":["$ n8n list:workflow","$ n8n list:workflow --active=true --onlyId","$ n8n list:workflow --active=false"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"active":{"name":"active","type":"option","description":"Filters workflows by active status. Can be true or false"},"onlyId":{"name":"onlyId","type":"boolean","description":"Outputs workflow IDs only, one per line.","allowNo":false}},"args":[]},"update:workflow":{"id":"update:workflow","description":"Update workflows","pluginName":"n8n","pluginType":"core","aliases":[],"examples":["$ n8n update:workflow --all --active=false","$ n8n update:workflow --id=5 --active=true"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"active":{"name":"active","type":"option","description":"Active state the workflow/s should be set to"},"all":{"name":"all","type":"boolean","description":"Operate on all workflows","allowNo":false},"id":{"name":"id","type":"option","description":"The ID of the workflow to operate on"}},"args":[]}}}