n8n 中文文档

使用命令行

服务器 CLI 是一个内置命令行界面,与 n8n 安装在同一台计算机上运行。它为管理任务提供直接数据库访问,即使在 n8n 未运行时也可以执行大多数命令。

提示

n8n CLI

希望从远程计算机以编程方式与 n8n 交互或与 AI 代理集成?查看 n8n CLI。

何时使用服务器 CLI vs n8n CLI

功能 服务器 CLI n8n CLI
运行位置 与 n8n 相同的机器 具有网络访问权限的任何机器
身份验证 直接数据库访问 API 密钥
需要运行 n8n 否(大多数命令) 是
最适合 实例操作员、备份、迁移 程序员、AI 代理、远程管理
安全模型 绕过访问控制 尊重用户权限和 API 密钥范围
用例示例 备份/恢复、许可证管理、紧急密码重置 工作流程自动化、通过代码进行凭证管理

运行 CLI 命令

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

  • npm:n8n命令可直接使用。该文档在下面的示例中使用了它。
  • Docker:n8n 命令在 Docker 容器中可用:

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

启动工作流程

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

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

n8n execute --id <ID>

发布或取消发布工作流程

您可以使用 CLI 发布或取消发布工作流程。在 n8n 2.0 中,先前的活动/非活动切换 被发布/取消发布模型取代。使用 publish:workflow 和 unpublish:workflow 从 CLI 更改工作流的发布状态。

提示

更改何时生效

这些命令会修改你的 n8n 数据库。正在运行的 n8n 何时应用更改取决于你的设置:

  • 如果 N8N_USE_WORKFLOW_PUBLICATION_SERVICE 已开启(默认如此),正在运行的实例会在不重启的情况下应用更改。默认每 15 秒检查一次更改。如果 n8n 没有在运行,它会在启动时应用更改。
  • 否则,请重启 n8n 以应用更改。

发布工作流程

使用 publish:workflow 通过 ID 发布工作流。您可以选择通过传递 versionId 来发布特定的历史版本。

publish:workflow 会执行与在编辑器中发布相同的检查,例如节点验证和 webhook 路径冲突。如果工作流未通过检查,该命令不会发布它,并打印原因。

警告

重新发布已发布的工作流

如果 N8N_USE_WORKFLOW_PUBLICATION_SERVICE 为 false,publish:workflow 会拒绝发布已经发布的工作流。请先取消发布该工作流,再重新发布,然后重启 n8n。

命令标志:

标志 描述
--help 帮助提示。
--id 要发布的工作流的 ID。必需的。
--versionId 要发布的可选版本 ID。如果省略,则发布当前草案。

提示

无 --all 标志

与已弃用的 update:workflow 命令不同,publish:workflow 不支持 --all。这是有意为之:它可以防止在生产环境中意外批量发布工作流程。按 ID 单独发布工作流程。

按 ID 发布工作流的当前草稿:

n8n publish:workflow --id=<ID>

发布工作流的特定历史版本:

n8n publish:workflow --id=<ID> --versionId=<VERSION_ID>

取消发布工作流程

使用 unpublish:workflow 按工作流 ID 取消发布工作流,或一次取消发布所有工作流。

命令标志:

标志 描述
--help 帮助提示。
--id 要取消发布的工作流的 ID。不能与 --all 一起使用。
--all 取消发布所有工作流程。不能与 --id 一起使用。

按工作流 ID 取消发布工作流:

n8n unpublish:workflow --id=<ID>

取消发布所有工作流程:

n8n unpublish:workflow --all

更新:工作流程(已弃用)

警告

功能可用性

update:workflow 命令从 n8n 2.0 开始已弃用并将被删除。请改用 publish:workflow 和 unpublish:workflow。详细信息请参见 n8n 2.0 重大变更。

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

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

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

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

这会发布该工作流的当前版本,检查和限制与 publish:workflow 相同。

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

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

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

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

导出实体

您可以使用 CLI 从 n8n 导出数据库实体。该工具允许您从一种数据库类型(例如 SQLite)导出所有实体类型,并将它们导入到另一种数据库类型(例如 Postgres)中。

命令标志:

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

导出工作流程和凭证

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

提示

规划完整备份

--backup 标志只导出工作流和凭据。有关自托管实例完整备份包含的内容以及恢复方法,请参阅备份和恢复。

命令标志:

标志 描述
--help 帮助提示。
--all 导出所有工作流程/凭证。
--backup 设置 --all --pretty --separate 进行备份。您可以选择设置--output。
--id 要导出的工作流程的 ID。
--output, -o 如果使用单独的文件,则输出文件名或目录。
--pretty 以更易于阅读的方式格式化输出。
--separate 每个工作流程导出一个文件(对于版本控制很有用)。必须使用 --output 设置目录。
--decrypted 以纯文本格式导出凭证。 (仅限凭据。)
--version 要导出的特定历史版本的版本 ID。 (仅限工作流程,不能与 --all 或 --published 一起使用。)
--published 导出工作流程的已发布/活动版本而不是当前草稿。与 --all 结合使用时,将跳过未发布的工作流程。 (仅限工作流程,不能与 --version 一起使用。)

工作流程

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

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/

导出特定工作流程版本

您可以通过将 versionId 与 --version 传递来导出工作流的特定历史版本:

n8n export:workflow --id=<ID> --version=<VERSION_ID> --output=workflow-v1.json

导出工作流程 的已发布版本

使用 --published 导出工作流程的当前发布/活动版本而不是当前草稿:

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

您可以将 --published 与 --all 组合起来导出每个工作流程的已发布版本。没有发布版本的工作流程将被跳过:

n8n export:workflow --all --published --output=workflows.json

提示

版本元数据

导出工作流时,n8n 包含一个 versionMetadata 属性,其中包含该版本的工作流的历史名称和描述。导入命令会在导入时将此数据保留在工作流历史记录表中。当前工作流程的名称和描述不会被覆盖。

凭证

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

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

进口实体

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

导入之前数据库预计为空,这可以使用 --truncateTables 参数强制执行。

命令标志:

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

导入工作流和凭据

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

警告

更新ID

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

可用标志:

标志 描述
--help 帮助提示。
--input 如果使用 --separate,则输入文件名或目录。
--projectId 将工作流或凭证导入到指定项目。不能与 --userId 一起使用。
--separate 从 --input 提供的目录导入 *.json 文件。
--userId 将工作流程或凭证导入到指定用户。不能与 --projectId 一起使用。
--skipMigrationChecks 跳过迁移验证检查。
--activeState 控制导入工作流的活动状态。接受 false(默认,停用所有导入的工作流程)或 fromJson(使用每个工作流程的 JSON 中的 active 字段;仅限多主模式)。

提示

迁移到 SQLite

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

这可能会导致在导入过程中出现诸如数据对于列名来说太长之类的错误。

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

工作流程

警告

已知问题:导入后 cron 触发器继续运行

导入先前活动的工作流程的行为因您运行的模式而异。这是一个已知的错误。

在多主和队列模式实例上,先前活动工作流的 cron 触发器在导入时将被停用。

在非多主实例上,之前活动的工作流 cron 触发器将保持运行,直到您重新启动 n8n 实例。

从特定文件导入工作流程:

n8n import:workflow --input=file.json

从指定目录导入所有工作流程文件为 JSON:

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

提示

导入时的版本元数据

如果导入的文件包含 versionMetadata 属性(通过针对特定版本或已发布版本的导出添加),n8n 会在工作流历史记录表中保留该历史名称和描述。当前工作流实体的名称和描述保持原样。

默认情况下,import:workflow 停用每个导入的工作流程。要保留每个 JSON 文件中的 active 字段,请传递 --activeState=fromJson (仅在多主和队列模式下受支持):

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

凭证

从特定文件导入凭据:

n8n import:credentials --input=file.json

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

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

许可证

清除

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

n8n license:clear

如果您的许可证包含 浮动权利[^1],运行此命令还将尝试将它们释放回池,使它们可用于其他实例。

信息

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

n8n license:info

用户管理

您可以使用 n8n CLI 重置用户管理。这会将用户管理返回到其预设置状态。它会删除所有用户帐户。

如果您忘记了密码,并且没有将 SMTP 设置为通过电子邮件重置密码,请使用此选项。

n8n user-management:reset

为用户禁用 MFA

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

n8n mfa:disable [email protected]

禁用 LDAP

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

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 实例上运行 安全审计,以检测常见安全问题。

n8n audit

[^1]:在 n8n 中,权利授予 n8n 实例在特定时间段内访问计划限制的功能。

相关资源

不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。