system · Command reference

`qzx welcome`

What it does

Displays the welcome screen with system information

Canonical command: welcome

Accepted aliases: welcome, hello, hi

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:83f0954799c74899a4251416920f13516aa9b02482b735462a0dea5453cc4043 on 2026-07-24.

Exact syntax

qzx welcome [full_info] --json

Parameters

Name	Type	Required	Default	Description
full_info	str	No	"true"	Show full system information (true/false)

Input examples

qzx Welcome

Display the welcome screen with full system information

qzx Welcome false

Display the basic welcome screen without detailed information

For the complete structured payload, add --json: qzx welcome [full_info] --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 Welcome --json

{
    "success": true,
    "message": "Displays the welcome screen with system information. In this illustrative example, the command completed successfully.",
    "info_level": "Example value",
    "output": "Command completed successfully with structured details.",
    "qzx_version": "0.2.2.0.2",
    "welcome_displayed": true
}

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": [],
        "info_level": [],
        "output": [],
        "qzx_version": [],
        "welcome_displayed": {
            "type": "boolean"
        }
    },
    "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/welcome.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