n8n-deploy Developer Documentation
Warning: These docs are for developers who want to understand, modify, or contribute to the n8n-deploy project.
Introduction
n8n-deploy is a powerful Python CLI tool for managing n8n workflows with a SQLite metadata store. This developer guide provides comprehensive information about the project’s architecture, development practices, and contribution guidelines.
“Programming is the art of telling another human what one wants the computer to do.” — Donald Knuth
Quick Links
Documentation
- System Architecture
- Contributing Guidelines
- Testing Framework
- Testing Guide (Comprehensive)
- CI/CD Troubleshooting
- API Reference
- Database Schema
- Local GitHub Pages Testing
Project Resources
- CONTRIBUTING.md - Full contribution guide
- CODE_OF_CONDUCT.md - Community guidelines
- CHANGELOG.md - Version history
- TODO.md - Planned features and roadmap
Key Project Goals
- Provide flexible, database-first workflow management
- Support remote n8n servers without web UI access
- Maintain clean, modular, and type-safe code
- Ensure comprehensive test coverage
Compatibility
- Python: 3.8+
- n8n: Latest versions (check documentation)
- Platforms: Linux, macOS, Windows Subsystem for Linux (WSL)
Before diving in, make sure you have the latest version of the project and its dependencies installed.