system · Command reference

`qzx checkExecutable`

What it does

Locates an executable in the system PATH and optionally reads its conventional --version output

Command maturity: Alpha

Available for real use and feedback while its interface and behavior can still evolve. This is the current development-checkout assessment. Every future immutable release tag preserves the exact assessment shipped by that version. Available in PyPI 0.2.2.0.9. This page documents the 0.2.2.0.9 alpha development checkout.

Behavior and built-in protections

Inspects without changing state

Direct execution for this operation

Uses a native tool when needed

Works without network access

No elevation required by design

The default lookup only inspects PATH and never starts the discovered program. --include-version runs the exact resolved path once, without a shell, with only --version, a reduced environment, a three-second timeout, and bounded retained output.

This safety classification was reviewed by OpenAI GPT-5.6 Pro against implementation digest sha256:2e82544698518dd4f8d5841dfeddf529af4cb85f5545836d66956c2612438f70 on 2026-08-25.

Exact syntax

qzx checkExecutable <executable> [include_version] --json

Parameters

Swipe or use the horizontal scrollbar to see every column.

Name	Type	Required	Default	Description
executable	str	Yes	Not declared	Executable name or explicit path to locate (for example: git, node, or docker)
include_version	bool	No	false	Run the exact resolved executable once with --version; disabled by default

Input examples

qzx checkExecutable git

Locate Git without executing it

qzx checkExecutable node --include-version

Locate Node.js and explicitly request its --version output

For the complete structured payload, add --json: qzx checkExecutable <executable> [include_version] --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 checkExecutable git --json

{
    "success": true,
    "message": "Locates an executable in the system PATH and optionally reads its conventional --version output. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "checkExecutable",
        "command_maturity": {
            "stage": "alpha",
            "label": "Alpha",
            "sequence": 2,
            "public_executable": true,
            "stability": "interface_may_change",
            "summary": "Available for real use and feedback while its interface and behavior can still evolve.",
            "promotion_review_required": false,
            "assessment_scope": "development_checkout"
        },
        "duration_ms": 0,
        "schema_version": 1
    },
    "available": true,
    "executable": "Example value",
    "executable_path": "C:\\project\\example.txt",
    "version": null,
    "version_checked": true,
    "version_probe": {
        "argument": "Example value",
        "return_code": "Example value",
        "output": "Command completed successfully with structured details.",
        "output_truncated": true
    },
    "version_requested": "Example value",
    "warnings": [
        {
            "name": "example",
            "status": "ok"
        }
    ]
}

View the JSON result contract

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message",
        "meta"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "meta": {
            "type": "object",
            "required": [
                "command",
                "command_maturity",
                "duration_ms",
                "schema_version"
            ],
            "properties": {
                "command": {
                    "type": "string"
                },
                "command_maturity": {
                    "type": "object",
                    "required": [
                        "stage",
                        "label",
                        "sequence",
                        "public_executable",
                        "stability",
                        "summary",
                        "promotion_review_required",
                        "assessment_scope"
                    ],
                    "properties": {
                        "stage": {
                            "type": "string"
                        },
                        "label": {
                            "type": "string"
                        },
                        "sequence": {
                            "type": "integer"
                        },
                        "public_executable": {
                            "type": "boolean"
                        },
                        "stability": {
                            "type": "string"
                        },
                        "summary": {
                            "type": "string"
                        },
                        "promotion_review_required": {
                            "type": "boolean"
                        },
                        "assessment_scope": {
                            "type": "string"
                        },
                        "note": {
                            "type": "string"
                        },
                        "review": {
                            "type": "object",
                            "required": [
                                "reviewed_on",
                                "rationale",
                                "evidence"
                            ],
                            "properties": {
                                "reviewed_on": {
                                    "type": "string",
                                    "format": "date"
                                },
                                "rationale": {
                                    "type": "string"
                                },
                                "evidence": {
                                    "type": "array",
                                    "minItems": 1,
                                    "items": {
                                        "type": "string"
                                    }
                                },
                                "replacement": {
                                    "type": "string"
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": true
                },
                "duration_ms": {
                    "type": "number"
                },
                "schema_version": {
                    "type": "integer"
                }
            },
            "additionalProperties": true
        },
        "available": {
            "type": "boolean"
        },
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "executable": [],
        "executable_path": [],
        "version": {
            "type": "null"
        },
        "version_checked": {
            "type": "boolean"
        },
        "version_probe": {
            "type": "object",
            "properties": {
                "argument": {
                    "type": "string"
                },
                "return_code": [],
                "output": [],
                "output_truncated": {
                    "type": "boolean"
                }
            },
            "additionalProperties": true
        },
        "version_requested": [],
        "warnings": {
            "type": "array"
        }
    },
    "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_executable.py
Tests: tests/test_system_commands/test_check_executable.py
Documentation channel: Development documentation 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
Availability: 0.2.2.0.9 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