开始使用 n8n CLI
n8n CLI 是一个轻量级命令行客户端,通过 n8n API 与正在运行的 n8n 实例进行通信。它可以在任何具有网络访问权限的计算机上运行,并使用 API 密钥进行身份验证。
使用 API CLI 可以:
- 列出并检查工作流程
- 从 JSON 创建工作流程
- 检查最近的执行情况
- 创建凭证
- 管理项目
所有操作均尊重用户的权限和 API 密钥的范围。
n8n CLI 与服务器 CLI
如果您需要管理 n8n 实例(备份、许可证管理、紧急重置),请参阅 服务器 CLI,这是一个与 n8n 在同一台计算机上运行的内置工具。
| 方面 | n8n CLI | 服务器 CLI |
|---|---|---|
| 运行自 | 具有网络访问权限的任何机器 | 与 n8n 相同的机器 |
| 身份验证 | API 密钥 | 直接数据库访问 |
| 需要 n8n 运行 | 是 | 否(大多数操作不需要) |
| 最适合 | 开发人员、集成、AI 代理 | 实例操作员、备份、紧急情况 |
| 权限 | 尊重用户角色和 API 关键范围 | 绕过访问控制 |
安装 n8n-cli
# Use directly with npx (zero install) <a href="#use-directly-with-npx-zero-install" id="use-directly-with-npx-zero-install"></a>
npx @n8n/cli workflow list
# Or install globally <a href="#or-install-globally" id="or-install-globally"></a>
npm install -g @n8n/cli
连接到您的实例
n8n-cli config set-url https://your-instance.n8n.cloud
n8n-cli config set-api-key YOUR_API_KEY
n8n-cli config show
- 配置保存到
~/.n8n-cli/config.json,文件权限受到限制 (0600)。 - 从 n8n > 设置 > n8n API 获取 API 密钥
或者,跳过配置文件并使用环境变量:
export N8N_URL=https://your-instance.n8n.cloud
export N8N_API_KEY=your_api_key
内联标志
n8n-cli --url=https://my-n8n.app.n8n.cloud --api-key=n8n_api_xxxxx workflow list
分辨率顺序
- 命令行标志(
--url、--api-key) - 环境变量(
N8N_URL、N8N_API_KEY) - 配置文件(
~/.n8n-cli/config.json)
命令
每个命令都支持--help,详细使用方法。
| 主题 | 命令 |
|---|---|
workflow |
list, get, create, update, delete, activate, deactivate, tags, transfer |
execution |
list, get, retry, stop, delete |
credential |
list, get, schema, create, delete, transfer |
project |
list, get, create, update, delete, members, add-member, remove-member |
tag |
list, create, update, delete |
variable |
list, create, update, delete |
data-table |
list, get, create, delete, rows, add-rows, update-rows, upsert-rows, delete-rows |
user |
list, get |
config |
set-url, set-api-key, show |
source-control |
pull |
package (preview) |
export, import, import-selection |
skill |
install |
audit |
(顶级) |
login / logout |
(顶级) |
输出格式
所有命令通过 --format 支持三种输出格式:
| 格式 | 标志 | 适用场景 |
|---|---|---|
| 表 | --format=table(默认) |
您想要人类可读的终端输出 |
| JSON | --format=json |
管道到 jq,编程使用 |
| 仅 ID | --format=id-only |
管道传输到 xargs,编写脚本 |
示例
- 人类可读的表格
bash
n8n-cli workflow list
- JSON 用于脚本
bash
n8n-cli workflow list --format=json | jq '.[] | select(.active) | .id'
- 将 ID 通过管道传输到另一个命令中
bash
n8n-cli workflow list --format=id-only | xargs -I{} n8n-cli workflow deactivate {}
与 Claude 代码 一起用作技能
安装技能,以便 Claude 始终知道如何使用 n8n-cli:
n8n-cli skill install --global
然后在Claude代码中,输入/n8n-cli来加载它。 Claude 现在可以代表您创建、更新和管理工作流程,而无需 MCP。
示例
列出并检查工作流程
n8n-cli workflow list
n8n-cli workflow get <id>
从 JSON 创建工作流程
cat workflow.json | n8n-cli workflow create --stdin
检查最近执行情况
n8n-cli execution list --status=error --limit=10
创建凭证
n8n-cli credential schema gmailOAuth2 # see required fields first
n8n-cli credential create --type=gmailOAuth2 --name='My Gmail' --file=cred.json
管理项目
n8n-cli project create --name="My Project"
n8n-cli workflow transfer <id> --project=<projectId>
导出和导入包
提示
预览状态
package 命令处于预览状态,在未来版本中可能会发生变化。
n8n-cli package export --workflow-id=<workflow-id> --output=export.n8np
n8n-cli package export --project-id=<project-id> --output=project.n8np
n8n-cli package import --file=export.n8np --conflict-policy=fail
n8n-cli package import --file=export.n8np --project-id=<project-id> --conflict-policy=skip
n8n-cli package import --file=export.n8np --project-id=<project-id> --data-table-schema-conflict-policy=overwrite-non-destructive
请参阅 n8n 封装 了解包的组成部分,并参阅 导入包 了解每个可用标志。
相关资源
不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。