system · Command reference

`qzx checkDependency`

What it does

Checks if a command-line dependency is installed in the system PATH and retrieves its version

Canonical command: checkDependency

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

Read-only under the current classification

No documented dry-run parameter

May invoke native programs

No documented network use

No inherent elevation requirement

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

Exact syntax

qzx checkDependency <dependency> --json

Parameters

Name	Type	Required	Default	Description
dependency	str	Yes	Not declared	Name of the executable or dependency to check (e.g., git, node, docker)

Input examples

qzx checkDependency git

Check if Git is installed and retrieve its version

qzx checkDependency node

Check if Node.js is installed

For the complete structured payload, add --json: qzx checkDependency <dependency> --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 checkDependency git --json

{
    "success": true,
    "message": "Checks if a command-line dependency is installed in the system PATH and retrieves its version. In this illustrative example, the command completed successfully.",
    "dependency": "Example value",
    "executable_path": "C:\\project\\example.txt",
    "installed": true,
    "version": "0.2.2.0.2",
    "version_error": "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"
        },
        "dependency": [],
        "error": {
            "type": "string"
        },
        "executable_path": [],
        "installed": {
            "type": "boolean"
        },
        "version": [],
        "version_error": []
    },
    "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 the supported operating-system matrix.

Evidence and provenance

Implementation: src/qzx/commands/system/check_dependency.py
Tests: tests/test_system_commands/test_check_dependency.py
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 system category. Compare them to choose the operation that best fits your task.

Explore all QZX commands