file · Command reference

`qzx copyFile`

What it does

Copies a file or directory from source to destination

Canonical command: copyFile

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

No documented network use

No inherent elevation requirement

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

Exact syntax

qzx copyFile <source> <destination> [recursive] [force] --json

Parameters

Name	Type	Required	Default	Description
source	str	Yes	Not declared	Path to the source file or directory
destination	str	Yes	Not declared	Path to the destination file or directory
recursive	str	No	Not declared	For directories: -r/--recursive to copy all contents, -rN/--recursiveN for N levels deep
force	bool	No	false	Whether to overwrite the destination if it exists

Input examples

qzx copyFile source.txt destination.txt

Copy a file to another file

qzx copyFile myfile.txt backup/myfile.txt

Copy a file to a directory

qzx copyFile sourcedir destinationdir -r

Copy a directory recursively (all contents)

qzx copyFile sourcedir destinationdir -r2

Copy a directory recursively up to 2 levels deep

qzx copyFile sourcedir destinationdir -r true

Copy a directory recursively and overwrite if exists

For the complete structured payload, add --json: qzx copyFile <source> <destination> [recursive] [force] --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 copyFile source.txt destination.txt --json

{
    "success": true,
    "message": "Copies a file or directory from source to destination. In this illustrative example, the command completed successfully.",
    "destination": "C:\\project\\example.txt",
    "file_size": 4096,
    "file_size_readable": "C:\\project\\example.txt",
    "force": true,
    "recursive": true,
    "source": "C:\\project\\example.txt",
    "type": "file",
    "warning": "Example value"
}

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"
        },
        "file_size": [],
        "file_size_readable": [],
        "force": [],
        "recursive": [],
        "source": [],
        "type": {
            "type": "string"
        },
        "warning": {
            "type": "string"
        }
    },
    "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 isolated disposable target.

Evidence and provenance

Implementation: src/qzx/commands/file/copy_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