A command-line interface for interacting with n8n
Project description
n8n-cli
A command-line interface for interacting with n8n workflow automation.
Note: Most commands work with standard n8n. However, the
triggercommand requires the execute workflow endpoint, which is pending merge into n8n core. Until then,triggerrequires a custom n8n build.
Installation
pip install n8n-cli
Or with pipx (recommended):
pipx install n8n-cli
Quick Start
# Configure your n8n instance
n8n-cli configure
# List all workflows
n8n-cli workflows
# Trigger a workflow
n8n-cli trigger <workflow-id>
# Check execution status
n8n-cli execution <execution-id>
Features
- Workflow Management - List, create, update, delete, enable, and disable workflows
- Execution Control - Trigger workflows, monitor executions, and retrieve results
- Flexible Output - JSON (default) or formatted tables
- Agent-Friendly - Designed for AI agent integration with structured JSON output
- Secure Configuration - Credentials stored with proper file permissions
Commands
| Command | Description |
|---|---|
configure |
Set up n8n API credentials |
workflows |
List all workflows |
workflow |
Get workflow details |
create |
Create a new workflow |
update |
Update an existing workflow |
update-node |
Update a specific node parameter |
delete |
Delete a workflow |
enable |
Activate a workflow |
disable |
Deactivate a workflow |
executions |
List workflow executions |
execution |
Get execution details |
trigger |
Trigger a workflow |
Documentation
For detailed documentation, see the Wiki:
- Configuration - Setup and environment variables
- Command Reference - Full command documentation
- Agent Integration - Using with AI agents
- Environment Variables - All configuration options
- Troubleshooting - Common issues and solutions
- Development - Contributing guide
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file n8n_cli-0.3.6.tar.gz.
File metadata
- Download URL: n8n_cli-0.3.6.tar.gz
- Upload date:
- Size: 377.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9b21240def35835827b1e85f3ae6ca34ca00ca37c4ba2483a908935b3beb6c55
|
|
| MD5 |
56047e9175b09ff291280642e48e3b83
|
|
| BLAKE2b-256 |
59204cc6b0183f04cc776714bdd00a475a71fa8237b02f822d216b85e50c389e
|
File details
Details for the file n8n_cli-0.3.6-py3-none-any.whl.
File metadata
- Download URL: n8n_cli-0.3.6-py3-none-any.whl
- Upload date:
- Size: 30.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2286d4116cff26a622b588b757d6c359b5c46ed358b5dc1901187b248bcc2290
|
|
| MD5 |
b440089a19ec37457c71cf28fdcf944f
|
|
| BLAKE2b-256 |
1c510b28ad98d0f5c350860f3d5da1bc1f9bd77b06f2150c2398b3d7d7d3904e
|