跳至内容

n8n 命令行指令#

n8n包含一个CLI(命令行界面),允许您使用CLI而非n8n编辑器执行操作。这些操作包括启动工作流,以及导出和导入工作流与凭据。

运行CLI命令#

您可以在自托管的n8n中使用CLI命令。根据您选择安装n8n的方式,运行命令的方式会有所不同:

  • npm: n8n 命令可直接使用。以下示例文档中均采用此方式。
  • Docker: n8n 命令在您的 Docker 容器中可用:

    1
    docker exec -u node -it  
    

启动工作流#

您可以直接使用CLI启动工作流。

通过ID执行已保存的工作流:

1
n8n execute --id <ID>

更改工作流的激活状态#

您可以使用CLI更改工作流的激活状态。

需要重新启动

这些命令会对您的n8n数据库进行操作。如果在n8n运行时执行这些命令,更改将在重启n8n后生效。

通过工作流ID将其活动状态设置为false:

1
n8n update:workflow --id=<ID> --active=false

通过工作流ID将其活动状态设置为true:

1
n8n update:workflow --id=<ID> --active=true

将所有工作流的活动状态设置为false:

1
n8n update:workflow --all --active=false

将所有工作流的活动状态设置为true:

1
n8n update:workflow --all --active=true

导出工作流和凭证#

您可以使用CLI从n8n导出工作流和凭据。

命令标志:

标志 描述
--help 帮助提示。
--all 导出所有工作流/凭证。
--backup 设置--all --pretty --separate用于备份。您可以选择性地设置--output。
--id 要导出的工作流ID。
--output 输出文件名或目录(如果使用单独文件)。
--pretty 以更易阅读的格式输出结果。
--separate 为每个工作流导出单独文件(适用于版本控制)。必须使用 --output 参数设置输出目录。
--decrypted 以纯文本格式导出凭据。

工作流#

将所有工作流导出到标准输出(终端):

1
n8n export:workflow --all

根据工作流ID导出并指定输出文件名:

1
n8n export:workflow --id=<ID> --output=file.json

将所有工作流导出到指定目录的单个文件中:

1
n8n export:workflow --all --output=backups/latest/file.json

使用--backup标志将所有工作流导出到指定目录(详情见上文):

1
n8n export:workflow --backup --output=backups/latest/

凭证#

将所有凭据导出到标准输出(终端):

1
n8n export:credentials --all

通过ID导出凭据并指定输出文件名:

1
n8n export:credentials --id=<ID> --output=file.json

将所有凭据导出到指定目录的单个文件中:

1
n8n export:credentials --all --output=backups/latest/file.json

使用--backup标志将所有凭证导出到指定目录(详情见上文):

1
n8n export:credentials --backup --output=backups/latest/

以纯文本格式导出所有凭据。您可以使用此功能从一个安装迁移到另一个配置文件中有不同密钥的安装。

敏感信息

所有敏感信息在文件中都可见。

1
n8n export:credentials --all --decrypted --output=backups/decrypted.json

导入工作流和凭证#

您可以通过CLI从n8n导入工作流和凭证。

更新ID

在导出工作流和凭据时,n8n也会导出它们的ID。如果现有数据库中已存在相同ID的工作流和凭据,它们将被覆盖。为避免这种情况,请在导入前删除或更改这些ID。

可用标志:

标志 描述
--help 帮助提示。
--input 如果使用--separate参数,则指定输入文件名或目录。
--projectId Import the workflow or credential to the specified project. Can't be used with --userId.
--separate Imports *.json files from directory provided by --input.
--userId Import the workflow or credential to the specified user. Can't be used with --projectId.

迁移到SQLite

n8n将工作流和凭证名称限制为128个字符,但SQLite不强制执行大小限制。

这可能会导致在导入过程中出现类似数据过长超出列名限制的错误。

在这种情况下,您可以直接从n8n界面编辑名称并重新导出,或者在导入前直接编辑JSON文件。

工作流#

从特定文件导入工作流:

1
n8n import:workflow --input=file.json

从指定目录导入所有工作流文件(JSON格式):

1
n8n import:workflow --separate --input=backups/latest/

凭证#

从特定文件导入凭据:

1
n8n import:credentials --input=file.json

从指定目录导入所有凭证文件为JSON格式:

1
n8n import:credentials --separate --input=backups/latest/

许可证#

清除#

从n8n数据库中清除现有许可证并将n8n重置为默认功能:

1
n8n license:clear

如果您的许可证包含浮动授权,运行此命令还将尝试将其释放回池中,使其可供其他实例使用。

信息#

显示有关现有许可证的信息:

1
n8n license:info

用户管理#

您可以使用n8n CLI重置用户管理功能。这将使用户管理恢复到预设状态,并删除所有用户账户。

如果您忘记了密码,并且没有设置SMTP通过电子邮件进行密码重置,请使用此功能。

1
n8n user-management:reset

为用户禁用多因素认证(MFA)#

如果用户丢失了恢复代码,您可以使用此命令为用户禁用MFA。之后用户将能够重新登录以再次设置MFA。

1
n8n mfa:disable --email=johndoe@example.com

禁用LDAP#

您可以使用以下命令重置LDAP设置。

1
n8n ldap:reset

安全审计#

您可以在n8n实例上运行安全审计,以检测常见的安全问题。

1
n8n audit
优云智算