Skip to main content

A command-line interface for interacting with n8n

Project description

n8n-cli logo

n8n-cli

A command-line interface for interacting with n8n workflow automation.

PyPI version Python versions License Tests Code style: ruff


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:

License

MIT

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

n8n_cli-0.3.1.tar.gz (376.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

n8n_cli-0.3.1-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

Details for the file n8n_cli-0.3.1.tar.gz.

File metadata

  • Download URL: n8n_cli-0.3.1.tar.gz
  • Upload date:
  • Size: 376.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for n8n_cli-0.3.1.tar.gz
Algorithm Hash digest
SHA256 4d3217bebc0c7799354f3620bdf64acf8b8ee63da5a2cdd038c95f339ebeda80
MD5 de744715644fea3495c815eb87e3d016
BLAKE2b-256 4576e7f3ec6c21f79d0589eff0724866ec89e78ed6457d076011917ac06ed82d

See more details on using hashes here.

File details

Details for the file n8n_cli-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: n8n_cli-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 30.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for n8n_cli-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0cb9a8e80aea3cde62f6e2411cbde4feb053e6d3f480924cfd6989f469da81c5
MD5 276677446227d606b3eb89277918d52c
BLAKE2b-256 34a84f10745534e9688abca0f29a8f68df1baefec204a036cf488b8a14aedcb6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page