system · Command reference

`qzx commandsBridge`

What it does

Executes allowlisted diagnostic system commands with bounded output

Canonical command: commandsBridge

Accepted aliases: bridge, cmd, run

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

May invoke native programs

No documented network use

No inherent elevation requirement

Executes a bounded allow-list of diagnostic native programs with shell expansion disabled, a 30-second timeout, and output limits. The built-in cd action changes only the QZX process working directory.

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

Exact syntax

qzx commandsBridge <command> [args] --json

Parameters

Name	Type	Required	Default	Description
command	str	Yes	Not declared	Allowlisted diagnostic command to execute
args	list[str]	No	[]	Arguments passed directly to the command without shell expansion

Input examples

qzx commandsBridge pwd

Shows the current working directory

qzx bridge whoami

Shows the current operating-system user

qzx cmd ping 127.0.0.1

Runs a local network diagnostic

qzx run hostname

Shows the current host name

For the complete structured payload, add --json: qzx commandsBridge <command> [args] --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 commandsBridge pwd --json

{
    "success": true,
    "message": "Executes allowlisted diagnostic system commands with bounded output. In this illustrative example, the command completed successfully.",
    "details": {
        "command": "qzx example --json",
        "exit_code": "Example value",
        "duration_seconds": 42.7,
        "output_truncated": "Example value"
    },
    "stdout": "Command completed successfully."
}

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"
        },
        "details": {
            "oneOf": [
                {
                    "type": "object",
                    "properties": {
                        "command": [],
                        "exit_code": [],
                        "duration_seconds": [],
                        "output_truncated": []
                    },
                    "additionalProperties": true
                },
                {
                    "type": "object",
                    "properties": {
                        "command": [],
                        "directory": []
                    },
                    "additionalProperties": true
                },
                {
                    "type": "object",
                    "properties": {
                        "command": [],
                        "simulated": {
                            "type": "boolean"
                        }
                    },
                    "additionalProperties": true
                },
                {
                    "type": "object",
                    "properties": {
                        "command": []
                    },
                    "additionalProperties": true
                },
                {
                    "type": "object",
                    "properties": {
                        "command": [],
                        "allowed_commands": []
                    },
                    "additionalProperties": true
                },
                {
                    "type": "object",
                    "properties": {
                        "command": [],
                        "stdout": [],
                        "stderr": []
                    },
                    "additionalProperties": true
                }
            ]
        },
        "error": {
            "oneOf": [
                {
                    "type": "null"
                },
                {
                    "type": "string"
                }
            ]
        },
        "error_code": {
            "type": "string"
        },
        "stderr": [],
        "stdout": []
    },
    "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/system/commands_bridge.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 system category. Compare them to choose the operation that best fits your task.

Explore all QZX commands