n8n-deploy: Database-First n8n Workflow Management CLI

“Complexity is the enemy of reliability.” — Arthur Bloch, Murphy’s Laws

Welcome to n8n-deploy, a powerful Python CLI tool for managing n8n workflows with a SQLite metadata store.

🌟 Key Features

• Database-First Management
  • SQLite as the single source of truth for workflow metadata
  • Efficient workflow management, metadata organization, and versioning
• Remote Server Integration
  • Seamless push/pull operations with n8n servers
  • Flexible configuration for multiple server environments
• API Key Management
  • Simple, secure lifecycle management
  • Plain text storage with easy configuration

🚀 Quick Start

Installation

pip install n8n-deploy

Full details in the Installation Guide

Initialize Database

n8n-deploy db init

Add API Key

echo "your_n8n_api_key" | n8n-deploy apikey add my_server

📖 Documentation

User Guides

• Installation Guide
• Getting Started
• Configuration

Core Features

• Database Management - SQLite operations and backups
• Workflow Management - Push/pull workflow operations
• API Key Management - Secure key handling
• Server Management - Multi-server configuration

Advanced Topics

• DevOps Integration - CI/CD pipelines and automation
• Troubleshooting - Common issues and solutions

Quick Reference

• Database Commands - CLI cheat sheet

🤝 Contributing

Interested in contributing? Check out our:

• Contributing Guide - How to contribute
• Code of Conduct - Community guidelines
• Changelog - Project history
• TODO - Planned features

📝 License

MIT License. See LICENSE for details.