system · Command reference

`qzx getRAMInfo`

What it does

Gets detailed information about system RAM usage

Canonical command: getRAMInfo

Accepted aliases: None

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:7778ca69accf65f5a5c0cf8bbc1659ab0ebfdb403254eb8de881d91bb8b8ddfb on 2026-07-24.

Exact syntax

qzx getRAMInfo --json

Parameters

Name	Type	Required	Default	Description
This command declares no parameters.

Input examples

qzx getRAMInfo

Get detailed information about system memory usage

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

{
    "success": true,
    "message": "Gets detailed information about system RAM usage. In this illustrative example, the command completed successfully.",
    "ram_info": {
        "total_bytes": 34359738368,
        "total_readable": "32.00 GiB",
        "available_bytes": 17179869184,
        "available_readable": "16.00 GiB",
        "percent_used": 50
    }
}

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"
        },
        "ram_info": []
    },
    "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/get_ram_info.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