Skip to main content

system · Command reference

qzx runScript

What it does

Executes one explicit Python, Bash, or Windows Batch script with a timeout and bounded retained 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.8. This page documents the 0.2.2.0.8 alpha development checkout.

Behavior and built-in protections

Live mode applies the changes you request

Direct execution for this operation

Uses a native tool when needed

Works without network access

Uses your current permissions; results can vary

Has no restorable filesystem target, so it executes a user-selected local script only with --dangerously-bypass-approvals-and-sandbox/--yolo. The bypass authorizes execution but does not sandbox the script. Output retention is bounded; QZX does not add argument values to result metadata, but the script can expose them through captured stdout or stderr.

For an operation without a restorable path, QZX asks for explicit --dangerously-bypass-approvals-and-sandbox or --yolo acknowledgement.

This safety classification was reviewed by OpenAI GPT-5.6 Sol against implementation digest sha256:215b544de7cc02c302210469d7ef8420e691eb65e183b42b6a960ae56a8c70ef on 2026-09-05.

Exact syntax

qzx runScript <script_path> [args] --json

Parameters

Swipe or use the horizontal scrollbar to see every column.

NameTypeRequiredDefaultDescription
script_pathstrYesNot declaredPath to the local script to execute
argslistNo[]Arguments passed to the script; QZX does not add their values to result metadata, but the script can print them in captured output

Input examples

qzx runScript myscript.py --yolo

Execute a reviewed Python script when its mutation targets cannot be determined

qzx runScript myscript.py arg1 arg2 --yolo

Execute with two arguments without QZX adding their values to result metadata

qzx runScript script.sh --dangerously-bypass-approvals-and-sandbox

Execute a reviewed Bash script without a safety backup

For the complete structured payload, add --json: qzx runScript <script_path> [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 runScript myscript.py --yolo --json

{
    "success": true,
    "message": "Executes one explicit Python, Bash, or Windows Batch script with a timeout and bounded retained output. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "runScript",
        "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
    },
    "execution": {
        "timeout_seconds": [
            {
                "name": "example",
                "status": "ok"
            }
        ],
        "exit_code": "Example value",
        "timed_out": true
    },
    "script": "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",
        "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
        },
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "execution": {
            "oneOf": [
                {
                    "type": "object",
                    "properties": {
                        "timeout_seconds": [],
                        "exit_code": [],
                        "timed_out": {
                            "type": "boolean"
                        }
                    },
                    "additionalProperties": true
                },
                {
                    "type": "object",
                    "properties": {
                        "timeout_seconds": [],
                        "exit_code": {
                            "type": "null"
                        },
                        "timed_out": {
                            "type": "boolean"
                        },
                        "termination": []
                    },
                    "additionalProperties": true
                }
            ]
        },
        "script": [],
        "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 a controlled privileged environment.

Evidence and provenance

Documentation channel
Development documentation 0.2.2.0.8 · main · sha256:9aa902dfb6b006017e52972bf7871fef49b03ec24ff80741231d743d0354bfc2
Availability
0.2.2.0.8 or earlier

Keep exploring

Related commands

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

Explore all QZX commands