Skip to content

Complete downloads

Complete downloads produce a gzip-compressed site archive on the node and safely extract it into a new or empty local directory.

Download the deployable scope

bash
zynohosting download example.com ./site-copy

The default scope mirrors what a full deployment manages. Platform configuration, generated caches, user uploads, logs, VCS data, dependencies, links, and special files are not included.

For non-interactive use:

bash
zynohosting download example.com ./site-copy --yes --json

Include sensitive content

Protected configuration and user-generated content require a separate permission and explicit option:

bash
zynohosting download example.com ./complete-copy --sensitive

DANGER

A sensitive snapshot may contain secrets, customer data, uploaded content, and application credentials. Protect its destination and do not commit it to source control.

Destination requirements

The destination must be either:

  • a path that does not exist; or
  • an empty directory.

Extraction happens in a temporary sibling directory. The CLI validates the complete archive before atomically moving the staged tree into place. Existing non-empty directories are never overlaid.

Archive safety

The downloader rejects:

  • absolute and traversal paths;
  • duplicate or invalid archive destinations;
  • symbolic links and hard links;
  • devices and other special entries;
  • entries outside protocol size and count limits.

The node agent also omits links and special files without following them and reports how many entries were skipped.

Options

OptionPurpose
--sensitiveInclude protected configuration and user-generated content.
-y, --yesDownload without prompting.
--jsonEmit one JSON result; requires --yes.
--timeout <seconds>Set the request timeout; default 600.

Permissions

ScopeRequired permission
Deployable snapshothosting.download
Sensitive snapshothosting.download and hosting.downloadSensitive

Verify a backup

A completed command proves transport and safe extraction, not application-level recoverability. For important backups, compare an inventory or hash manifest and test restoration in an isolated environment.

Documentation for the ZynoHosting CLI and local MCP server.