system · Command reference

qzx getCurrentUser

What it does

Gets information about the currently logged in user

Canonical command: getCurrentUser

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:c631c4dfa9d6c02606268d051dc3252ff3d64f2224a8e938589abdee8da035a6 on 2026-07-25.

Exact syntax

qzx getCurrentUser --json

Parameters

NameTypeRequiredDefaultDescription
This command declares no parameters.

Input examples

qzx getCurrentUser

Get detailed information about the currently logged in user

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

{
    "success": true,
    "message": "Gets information about the currently logged in user. In this illustrative example, the command completed successfully.",
    "current_directory": "C:\\project\\example.txt",
    "environment_variables": {
        "PATH_entries": 14,
        "shell": "PowerShell"
    },
    "home_directory": "C:\\Users\\developer",
    "processes": {
        "value": [
            {
                "pid": 4210,
                "name": "python",
                "cpu_percent": 4.2,
                "memory_readable": "82.4 MiB"
            }
        ]
    },
    "shell": "Example value",
    "user_id": "Example value",
    "username": "developer"
}
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"
        },
        "current_directory": [],
        "environment_variables": {
            "type": "object",
            "properties": [],
            "additionalProperties": true
        },
        "error": [],
        "home_directory": [],
        "processes": {
            "oneOf": [
                {
                    "type": "object",
                    "properties": [],
                    "additionalProperties": true
                },
                {
                    "type": "object",
                    "properties": {
                        "count": [],
                        "total_memory_usage": []
                    },
                    "additionalProperties": true
                }
            ]
        },
        "shell": [],
        "user_id": [],
        "username": {
            "oneOf": [
                {
                    "type": "null"
                },
                {
                    "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: ready for deterministic automated capture.

Evidence and provenance

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