system · Command reference

`qzx listProcesses`

What it does

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

Command maturity: Alpha

Available for real use and feedback while its interface and behavior can still evolve. This is the current development-checkout assessment. Every future immutable release tag preserves the exact assessment shipped by that version. Available in PyPI 0.2.2.0.8. This page documents the 0.2.2.0.8 alpha development checkout.

Behavior and built-in protections

Inspects without changing state

Direct execution for this operation

Works without invoking native programs

Works without network access

No elevation required by design

This safety classification was reviewed by OpenAI GPT-5.6 Pro against implementation digest sha256:d4034861218b64880e150d33b844be1d4dd3f00efda4a347c624e18e3a70df80 on 2026-08-25.

Exact syntax

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

Parameters

Swipe or use the horizontal scrollbar to see every column.

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.",
    "meta": {
        "command": "listProcesses",
        "command_maturity": {
            "stage": "alpha",
            "label": "Alpha",
            "sequence": 2,
            "public_executable": true,
            "stability": "interface_may_change",
            "summary": "Available for real use and feedback while its interface and behavior can still evolve.",
            "promotion_review_required": false,
            "assessment_scope": "development_checkout"
        },
        "duration_ms": 0,
        "schema_version": 1
    },
    "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",
        "meta"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "meta": {
            "type": "object",
            "required": [
                "command",
                "command_maturity",
                "duration_ms",
                "schema_version"
            ],
            "properties": {
                "command": {
                    "type": "string"
                },
                "command_maturity": {
                    "type": "object",
                    "required": [
                        "stage",
                        "label",
                        "sequence",
                        "public_executable",
                        "stability",
                        "summary",
                        "promotion_review_required",
                        "assessment_scope"
                    ],
                    "properties": {
                        "stage": {
                            "type": "string"
                        },
                        "label": {
                            "type": "string"
                        },
                        "sequence": {
                            "type": "integer"
                        },
                        "public_executable": {
                            "type": "boolean"
                        },
                        "stability": {
                            "type": "string"
                        },
                        "summary": {
                            "type": "string"
                        },
                        "promotion_review_required": {
                            "type": "boolean"
                        },
                        "assessment_scope": {
                            "type": "string"
                        },
                        "note": {
                            "type": "string"
                        },
                        "review": {
                            "type": "object",
                            "required": [
                                "reviewed_on",
                                "rationale",
                                "evidence"
                            ],
                            "properties": {
                                "reviewed_on": {
                                    "type": "string",
                                    "format": "date"
                                },
                                "rationale": {
                                    "type": "string"
                                },
                                "evidence": {
                                    "type": "array",
                                    "minItems": 1,
                                    "items": {
                                        "type": "string"
                                    }
                                },
                                "replacement": {
                                    "type": "string"
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": true
                },
                "duration_ms": {
                    "type": "number"
                },
                "schema_version": {
                    "type": "integer"
                }
            },
            "additionalProperties": true
        },
        "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.8 · main · sha256:9aa902dfb6b006017e52972bf7871fef49b03ec24ff80741231d743d0354bfc2
Availability: 0.2.2.0.8 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