system · Command reference

`qzx listProcesses`

What it does

Lists running processes (similar to 'ps' in Unix)

Canonical command: listProcesses

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:3d455dd7d8520742c939428a7f1ad47207fcd8b0000b59be5cefbd837744c140 on 2026-07-24.

Exact syntax

qzx listProcesses [filter_str] [sort_by] [limit] --json

Parameters

Name	Type	Required	Default	Description
filter_str	str	No	Not declared	Optional string to filter process names
sort_by	str	No	"cpu"	Field to sort results by (pid, cpu, memory, name)
limit	int	No	0	Maximum number of processes to display

Input examples

qzx listProcesses

List all processes

qzx listProcesses python

List processes containing "python" in their name

qzx listProcesses null memory 10

List the top 10 processes by memory usage

For the complete structured payload, add --json: qzx listProcesses [filter_str] [sort_by] [limit] --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 listProcesses --json

{
    "success": true,
    "message": "Lists running processes (similar to 'ps' in Unix). In this illustrative example, the command completed successfully.",
    "displayed_processes": 3,
    "filter": "Example value",
    "limit": null,
    "os_type": "Windows",
    "processes": [
        {
            "pid": 4210,
            "name": "python",
            "cpu_percent": 4.2,
            "memory_readable": "82.4 MiB"
        }
    ],
    "sort_by": "Example value",
    "stats": {
        "top_cpu_process": {
            "pid": "Example value",
            "name": "Example value",
            "cpu_percent": 42.7
        },
        "top_memory_process": {
            "pid": "Example value",
            "name": "Example value",
            "memory_percent": 42.7,
            "memory_rss_readable": "4.00 KiB"
        }
    },
    "total_processes": 3
}

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"
        },
        "displayed_processes": {
            "type": "integer"
        },
        "error": {
            "type": "string"
        },
        "filter": [],
        "limit": {
            "type": "null"
        },
        "os_type": [],
        "processes": {
            "type": "array"
        },
        "sort_by": [],
        "stats": {
            "type": "object",
            "properties": {
                "top_cpu_process": {
                    "type": "object",
                    "properties": {
                        "pid": [],
                        "name": [],
                        "cpu_percent": []
                    },
                    "additionalProperties": true
                },
                "top_memory_process": {
                    "type": "object",
                    "properties": {
                        "pid": [],
                        "name": [],
                        "memory_percent": [],
                        "memory_rss_readable": []
                    },
                    "additionalProperties": true
                }
            },
            "additionalProperties": true
        },
        "total_processes": {
            "type": "integer"
        }
    },
    "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/list_processes.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