system · Command reference

`qzx terminal`

What it does

Launches an interactive terminal/shell for QZX commands

Canonical command: terminal

Accepted aliases: term, shell, console, repl

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

No native program invocation in the current classification

No documented network use

No inherent elevation requirement

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

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

Exact syntax

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

Parameters

Name	Type	Required	Default	Description
prompt	str	No	"QZX> "	Custom prompt for the terminal (default: "QZX> ")
history_file	str	No	Not declared	Optional path to a persistent history file (disabled by default)
show_path	bool	No	true	Show path in the prompt (default: true)

Input examples

qzx Terminal

Launch the QZX interactive terminal with default settings

qzx Shell

Launch the QZX interactive terminal using the Shell alias

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."
}

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"
        },
        "error": {
            "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

Implementation: src/qzx/commands/system/terminal.py
Tests: tests/test_terminal.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