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: Most commands work with standard n8n. However, the trigger command requires the execute workflow endpoint, which is pending merge into n8n core. Until then, trigger requires 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:

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: n8n_cli-0.3.5.tar.gz
  • Upload date:
  • Size: 377.0 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.5.tar.gz
Algorithm Hash digest
SHA256 134a5ad14bf0df360bc0e9691e37a2d73b3310b984ed1ffbf68470c0325b2c3e
MD5 db02a7f06ec896681523545af25585bc
BLAKE2b-256 035527692df8a6bae72b06f9c1bc6e66d3fdb5d5e74a5b7cc12eb3b43d895b11

See more details on using hashes here.

File details

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

File metadata

  • Download URL: n8n_cli-0.3.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d30bc6a1ddc2048bec903d01cdb4a777aecc5ba497adf8cddaef4d090c12115a
MD5 fa6d7d40bb32448aa90b6bbb02d626b9
BLAKE2b-256 dcabd552d5dfa17d677ecc87120f037b4cb4d79896b1a9a513063fe8f0696e30

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