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


Note: The trigger command requires n8n with the execute workflow endpoint. This PR is pending merge into n8n core. Until then, you'll need to use a custom n8n build with this endpoint enabled.

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:

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.4.tar.gz (376.9 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.4-py3-none-any.whl (30.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: n8n_cli-0.3.4.tar.gz
  • Upload date:
  • Size: 376.9 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.4.tar.gz
Algorithm Hash digest
SHA256 37d1d41fb47f5cb65d9fdedcc5b01f09261b99d096ea256f80c8b669bc9e4642
MD5 b9c4c39e146a7bc045343285b1d35464
BLAKE2b-256 38c674ff60346ce21d3576ee9ee6e028d92f59a06d60a62b8100c723ea2abe77

See more details on using hashes here.

File details

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

File metadata

  • Download URL: n8n_cli-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 30.4 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 187c029cd06482635b1b13b4a3fc5a2a5b91ada0a000379997e70c3f6ae39caf
MD5 34d7cfcdd52092904a6be6973ece6a07
BLAKE2b-256 f1afe79c57c99bf87f369c77da8436d4e91bb2b39cdbdfd5d16a18baa1750825

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