Ndeploy at a Glance
Deterministic project-first CLI for promoting n8n releases from DEV to PROD. Plan dependencies, prepare production credentials, validate them, and apply with full operator control.
Automatically finds and manages sub-workflows, credentials, and data tables required for your deployment.
Root workflows are never auto-published. Human intervention via a manual command is required for final activation.
Resources are matched in PROD by name. Updates are skipped if content is already equivalent, ensuring stability.
Run init with a DEV workflow id to create a project folder and persist root workflow metadata.
Run plan <project>, review reports/plan_summary.json, then run credentials fetch <project>, credentials compare <project>, credentials merge-missing <project>, and credentials validate <project> --side manifest --strict.
Deploy with apply <project>, inspect reports/deploy_summary.json, then manually publish root workflow.
Simple, direct CLI interface for your daily operations.
1. Create project from DEV workflow
ndeploy init <workflow_id_dev> [project_root]
2. Generate plan in project
ndeploy plan <project>
3. Fetch source/target snapshots
ndeploy credentials fetch <project>
4. Compare and seed the manifest
ndeploy credentials compare <project> && ndeploy credentials merge-missing <project>
5. Validate credential readiness
ndeploy credentials validate <project> --side manifest --strict
6. Apply to production
ndeploy apply <project>
7. Inspect project status
ndeploy info <project>
8. Manual activation
ndeploy publish <workflow_id_prod>
9. Find orphans / dangling refs
ndeploy orphans <project> --side target && ndeploy dangling-refs <project> --side target
credentials_manifest.json. The operator fetches source/target, compares them, seeds missing entries into the manifest, and reviews that manifest before apply.
publish command to ensure a human has reviewed the deployment before it goes live.
ndeploy remove with selectors like --workflows, --credentials, --data-tables, or --all. Without --yes, NDploy asks for interactive confirmation.
orphans lists entities not referenced by any non-archived workflow. dangling-refs lists workflows that reference entities that no longer exist.
source maps to N8N_DEV_* and target maps to N8N_PROD_*.
-o or --output with remove, orphans, and dangling-refs to persist result JSON to a file.
