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:

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.3.tar.gz (376.8 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.3-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: n8n_cli-0.3.3.tar.gz
  • Upload date:
  • Size: 376.8 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.3.tar.gz
Algorithm Hash digest
SHA256 0534cd944263dfcfa2a82d4937c444f7647f6fd40007349fef8526b8e43f90f6
MD5 f66b0be423f55f5c97964531df345f6f
BLAKE2b-256 b28201789b36ecbf7c410f485d9436a552526437366fd330a61338c7fcc60648

See more details on using hashes here.

File details

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

File metadata

  • Download URL: n8n_cli-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 30.3 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3afc0dfc14a07ee47b7a616c316e6679dee1a1b3e6e5957360917f2d3424210e
MD5 dcd2d3e399ae7612b8782ce3c4f791ac
BLAKE2b-256 15538d89ea8dbd2abac04dfed0211379107aaca4862e27e1ec77c2f7bcb8be59

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