file · Command reference

`qzx downloadFile`

What it does

Downloads a file from the Internet (similar to 'wget' or 'curl' in Unix)

Canonical command: downloadFile

Accepted aliases: None

Case-sensitive: no

Included in the published package

Available in PyPI 0.2.2.0.2. This page documents the 0.2.2.0.2 alpha development checkout.

Safety and effects

Can mutate state

No documented dry-run parameter

No native program invocation in the current classification

May use the network

No inherent elevation requirement

This safety classification was reviewed against implementation digest sha256:8fb6c67afc1c4d9d1b026b97564afcada5326426a67d45916397984556f817bb on 2026-07-24.

Exact syntax

qzx downloadFile <url> <destination_path> [show_progress] [timeout] --json

Parameters

Name	Type	Required	Default	Description
url	str	Yes	Not declared	URL of the file to download
destination_path	str	Yes	Not declared	Path where to save the downloaded file
show_progress	bool	No	true	Whether to show download progress
timeout	int	No	30	Maximum wait time in seconds

Input examples

qzx downloadFile https://example.com/file.txt downloads/file.txt

Download a sample file

qzx downloadFile https://example.com/file.zip downloads/file.zip false

Download a file without showing progress

qzx downloadFile https://example.com/large-file.iso downloads/file.iso true 120

Download a large file with extended timeout

For the complete structured payload, add --json: qzx downloadFile <url> <destination_path> [show_progress] [timeout] --json

Representative output example

This illustrative JSON is derived from the current implementation-backed result contract. It shows what the command can return without claiming a recorded execution; values vary with inputs, host, permissions, and optional tools.

Example command: qzx downloadFile https://example.com/file.txt downloads/file.txt --json

{
    "success": true,
    "message": "Downloads a file from the Internet (similar to 'wget' or 'curl' in Unix). In this illustrative example, the command completed successfully.",
    "destination": "C:\\project\\example.txt",
    "show_progress": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "start_time": "Example value",
    "timeout": "Example value",
    "url": "https://example.com"
}

View the JSON result contract

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "destination": [],
        "error": {
            "type": "string"
        },
        "show_progress": [],
        "start_time": [],
        "timeout": [],
        "url": []
    },
    "additionalProperties": true
}

Errors and limits

The public contract requires success=false and a descriptive message on failure. This catalog does not yet declare a command-specific error taxonomy; inspect the result and do not invent error codes.

QZX is alpha software. Optional dependencies, permissions, and host capabilities can change the result.

Evidence workflow: requires an authorized endpoint or reviewed fixture.

Evidence and provenance

Implementation: src/qzx/commands/file/download_file.py
Tests: No command-specific test file with the same module name was found; this does not prove that all coverage is absent.
Documentation channel: Development documentation 0.2.2.0.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
Availability: 0.2.2.0.2 or earlier

Keep exploring

These commands also belong to the file category. Compare them to choose the operation that best fits your task.

Explore all QZX commands