system · Command reference
qzx inspectPort
What it does
Checks whether a local port is bound and reports the owning process without terminating it
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
Uses a native tool when needed
Works without network access
Uses your current permissions; results can vary
inspectPort is strictly read-only and never changes process state.
This safety classification was reviewed by OpenAI GPT-5.6 Pro against implementation digest sha256:c363f820e99c9a68673ff8b09468bcbcd7a3fe7ec1545dcfcfb7d00548ff0994 on 2026-08-25.
Exact syntax
qzx inspectPort <port> --jsonParameters
Swipe or use the horizontal scrollbar to see every column.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| port | int | Yes | Not declared | Port number to inspect |
Input examples
qzx inspectPort 3000Inspect the listener and obtain its PID and creation time
qzx inspectPort 5432 --jsonReturn the complete structured inspection result
For the complete structured payload, add --json: qzx inspectPort <port> --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 inspectPort 3000 --json
{
"success": true,
"message": "Checks whether a local port is bound and reports the owning process without terminating it. In this illustrative example, the command completed successfully.",
"meta": {
"command": "inspectPort",
"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
},
"errors": [],
"in_use": "Example value",
"limitations": [
"Example value"
],
"observed_pids": [
3
],
"port": 3,
"processes": [
{
"pid": 4210,
"name": "python",
"cpu_percent": 4.2,
"memory_readable": "82.4 MiB"
}
],
"status": "free"
}View the JSON result contract
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
},
"error": {
"type": "string"
},
"error_code": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"free",
"in_use"
]
},
"port": {
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"in_use": {
"type": [
"boolean",
"null"
]
},
"observed_pids": {
"type": "array",
"items": {
"type": "integer"
}
},
"processes": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"limitations": {
"type": "array",
"items": {
"type": "string"
}
},
"errors": {
"type": "array",
"items": {
"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
}
},
"additionalProperties": true,
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"message",
"meta",
"success"
]
}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: requires a controlled privileged environment.
Evidence and provenance
- Implementation
- src/qzx/commands/system/inspect_port.py
- Documentation channel
- Development documentation 0.2.2.0.8 · main · sha256:9aa902dfb6b006017e52972bf7871fef49b03ec24ff80741231d743d0354bfc2
- Availability
- 0.2.2.0.8 or earlier
Keep exploring
Related commands
These commands also belong to the system category. Compare them to choose the operation that best fits your task.
qzx helpShows help for a commandqzx isAdminChecks if the current user has administrative privilegesqzx getSystemInfoGets portable operating-system, Python, user, and environment information with optional RAM and storage detailsqzx killProcessTerminates one explicitly identified process and verifies that it exited