Skip to content

n8n 的 CLI 命令#

n8n 包含一个 CLI（命令行界面），允许您使用 CLI 而不是 n8n 编辑器执行操作。这些操作包括启动工作流，以及导出和导入工作流和凭据。

运行 CLI 命令#

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

  • npm：n8n 命令直接可用。文档在下面的示例中使用这种方式。

  • Docker：n8n 命令在您的 Docker 容器内可用：

    1
    docker exec -u node -it <n8n-container-name> <n8n-cli-command>

启动工作流#

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

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

1
n8n execute --id <ID>

更改工作流的活动状态#

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

需要重启

这些命令操作您的 n8n 数据库。如果您在 n8n 运行时执行这些命令，更改不会生效，直到您重启 n8n。

将工作流的活动状态设置为 false（通过 ID）：

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

将工作流的活动状态设置为 true（通过 ID）：

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

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

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

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

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

Export entities 导出实体#

您可以使用 CLI 从 n8n 导出数据库实体。此工具允许您从一种数据库类型（如 SQLite）导出所有实体类型，并将它们导入到另一种数据库类型（如 Postgres）。

命令标志：

标志 描述
--help 帮助提示。
--outputDir 输出目录路径
--includeExecutionHistoryDataTables 包含执行历史数据表，默认情况下排除这些表，因为它们可能非常大 
1
n8n export:entities --outputDir ./outputs --includeExecutionHistoryDataTables true

Export workflows and credentials 导出工作流和凭据#

您可以使用 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

Import entities 导入实体#

您可以使用此命令导入先前 export:entities 命令的实体，它允许将实体导入到与导出数据库类型不同的数据库类型中。当前支持的数据库类型包括：SQLite、Postgres。

导入前数据库应该是空的，可以使用 --truncateTables 参数强制执行。

命令标志：

标志 描述
--help 帮助提示。
--inputDir 保存导入输出文件的输入目录
--truncateTables 导入前截断表 
1
n8n import:entities --inputDir ./outputs --truncateTables true

Import workflows and credentials 导入工作流和凭据#

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

更新 ID

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

可用标志：

标志 描述
--help 帮助提示。
--input 输入文件名或目录（如果您使用 --separate）。
--projectId 将工作流或凭据导入到指定项目。不能与 --userId 一起使用。
--separate 从 --input 提供的目录导入 *.json 文件。
--userId 将工作流或凭据导入到指定用户。不能与 --projectId 一起使用。

迁移到 SQLite

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

这可能导致在导入过程中出现类似 Data too long for column name 的错误。

在这种情况下，您可以从 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=[email protected]

禁用 LDAP#

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

1
n8n ldap:reset

卸载社区节点和凭据#

您可以使用 n8n CLI 管理社区节点。目前，您只能卸载社区节点和凭据，这在社区节点导致不稳定时很有用。

命令标志：

标志 描述
--help 显示 CLI 帮助。
--credential 凭据类型。通过访问节点的 <NODE>.credential.ts 文件并获取 name 的值来获取此值。
--package 社区节点的包名。
--uninstall 卸载节点。
--userId 拥有凭据的用户的 ID。在自托管上，查询数据库。在云上，使用您的 API 密钥查询 API。

节点#

通过包名卸载社区节点：

1
n8n community-node --uninstall --package <COMMUNITY_NODE_NAME>

例如，要卸载 Evolution API 社区节点，请输入：

1
n8n community-node --uninstall --package n8n-nodes-evolution-api

凭据#

卸载社区节点凭据：

1
n8n community-node --uninstall --credential <CREDENTIAL_TYPE> --userId <ID>

例如，要卸载 Evolution API 社区节点凭据，请访问仓库并导航到 credentials.ts 文件以查找 name：

1
n8n community-node --uninstall --credential evolutionApi --userId 1234

安全审计#

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

1
n8n audit