Home

n8n-cli

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

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

Installation

Using pip

pip install n8n-cli

Using pipx (recommended for CLI tools)

pipx install n8n-cli

Development Installation

# Clone the repository
git clone https://github.com/TidalStudio/n8n-cli.git
cd n8n-cli

# Create a virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install in development mode
pip install -e ".[dev]"

Quick Start

# 1. Configure credentials
n8n-cli configure

# 2. List all workflows
n8n-cli workflows

# 3. Trigger a workflow
n8n-cli trigger 123

# 4. Check execution status
n8n-cli execution 456

Documentation

• Configuration - Setup and environment variables
• Command Reference - Full command documentation
• Agent Integration - Using with AI agents
• Environment Variables - All environment variable options
• Troubleshooting - Common issues and solutions
• Development - Contributing guide