n8n 的 CLI 命令#

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

运行 CLI 命令#

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

npm：可以直接使用 n8n 命令。下面的示例中使用了这种方式。

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

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

启动工作流#

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

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

n8n execute --id <ID>

更改工作流的激活状态#

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

需要重启

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

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

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

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

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

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

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

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

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 导出工作流并指定输出文件名：

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

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

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

使用 --backup 标志将所有工作流导出到特定目录（详情见上文）：

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

凭证#

将所有凭证导出到标准输出（终端）：

1	`n8n export:credentials --all`

通过 ID 导出凭证并指定输出文件名：

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

将所有凭证导出到特定目录的单个文件中：

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

使用 --backup 标志将所有凭证导出到特定目录（详情见上文）：

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

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

敏感信息

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

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

导入工作流和凭证#

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

工作流#

从特定文件导入工作流：

n8n import:workflow --input=file.json

从指定目录导入所有工作流文件（JSON 格式）：

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

凭证#

从特定文件导入凭证：

n8n import:credentials --input=file.json

从指定目录导入所有凭证文件（JSON 格式）：

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。

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。

节点#

通过包名卸载社区节点：

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

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

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

凭证#

卸载社区节点凭证：

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

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

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

安全审计#

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

1	`n8n audit`

此页面是否

💬 微信

🚀 与作者交流

关注公众号

n8n实战笔记
📚 教程 💡 案例 🔧 技巧

添加微信

1对1 专业指导
⚡ 快答 🎯 定制 🚀 支持

添加后请直说来意，看到会回复。谢谢