system · Command reference

`qzx clearScreen`

What it does

Clears the terminal screen

Canonical command: clearScreen

Accepted aliases: cls, clear, clrscr

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

Read-only under the current classification

No documented dry-run parameter

No native program invocation in the current classification

No documented network use

No inherent elevation requirement

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

Exact syntax

qzx clearScreen --json

Parameters

Name	Type	Required	Default	Description
This command declares no parameters.

Input examples

qzx ClearScreen

Clear the terminal screen

qzx cls

Clear the terminal screen (using alias)

For the complete structured payload, add --json: qzx clearScreen --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 ClearScreen --json

{
    "success": true,
    "message": "Clears the terminal screen. In this illustrative example, the command completed successfully.",
    "screen_cleared": true,
    "warning": "Example value"
}

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": [],
        "screen_cleared": {
            "type": "boolean"
        },
        "warning": []
    },
    "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: ready for deterministic automated capture.

Evidence and provenance

Implementation: src/qzx/commands/system/clear_screen.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