development · Command reference

`qzx projectDoctor`

What it does

Inspects project health: detects tech stack, dependencies, environment configuration, Git state, test suites, circular imports, dead code, and large files

Canonical command: projectDoctor

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

May invoke native programs

No documented network use

No inherent elevation requirement

This safety classification was reviewed against implementation digest sha256:6635a919f7b4e35a7ee9acfeb07b51782818ef14e9f436d1be3ae52f92de557e on 2026-07-24.

Exact syntax

qzx projectDoctor [path] --json

Parameters

Name	Type	Required	Default	Description
path	str	No	"."	Path to the project directory to diagnose (default: '.')

Input examples

qzx projectDoctor

Run project health diagnosis for current directory

qzx projectDoctor C:/my/project

Diagnose project at specified path

For the complete structured payload, add --json: qzx projectDoctor [path] --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 projectDoctor --json

{
    "success": true,
    "message": "Inspects project health: detects tech stack, dependencies, environment configuration, Git state, test suites, circular imports, dead code, and large files. In this illustrative example, the command completed successfully.",
    "details": {
        "summary": "Additional structured context is included here."
    }
}

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"
        },
        "details": [],
        "error": {
            "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: requires the supported operating-system matrix.

Evidence and provenance

Implementation: src/qzx/commands/development/project_doctor.py
Tests: tests/test_development_commands/test_project_doctor.py
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 development category. Compare them to choose the operation that best fits your task.

Explore all QZX commands