Skip to main content

system · Command reference

qzx terminal

What it does

Launches an interactive terminal/shell for QZX commands

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

Works without invoking native programs

Works without network access

No elevation required by design

Dispatches QZX commands interactively. Persistent history is disabled unless a history file is explicitly selected.

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

Exact syntax

qzx terminal [prompt] [history_file] [show_path] --json

Parameters

Swipe or use the horizontal scrollbar to see every column.

NameTypeRequiredDefaultDescription
promptstrNo"QZX> "Custom prompt for the terminal (default: "QZX> ")
history_filestrNoNot declaredOptional path to a persistent history file (disabled by default)
show_pathboolNotrueShow path in the prompt (default: true)

Input examples

qzx terminal

Launch the QZX interactive terminal with default settings

qzx terminal "Agent> "

Launch the QZX interactive terminal with an agent prompt

qzx terminal "MyQZX> "

Launch the QZX terminal with a custom prompt

qzx terminal "QZX> " --history_file ~/.qzx_history --show_path false

Opt in to persistent history and hide the path

For the complete structured payload, add --json: qzx terminal [prompt] [history_file] [show_path] --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 terminal --json

{
    "success": true,
    "message": "Launches an interactive terminal/shell for QZX commands. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "terminal",
        "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
    },
    "details": {
        "prompt": "Example value",
        "history_enabled": true,
        "history_file": "C:\\project\\example.txt",
        "show_path": "C:\\project\\example.txt"
    }
}
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
        },
        "details": {
            "oneOf": [
                {
                    "type": "object",
                    "properties": {
                        "prompt": [],
                        "history_enabled": {
                            "type": "boolean"
                        },
                        "history_file": [],
                        "show_path": []
                    },
                    "additionalProperties": true
                },
                {
                    "type": "object",
                    "properties": {
                        "history_enabled": {
                            "type": "boolean"
                        },
                        "show_path": []
                    },
                    "additionalProperties": true
                }
            ]
        },
        "error": {
            "type": "string"
        },
        "error_code": {
            "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

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