development · Command reference

`qzx analyzeComplexity`

What it does

Analyzes code complexity metrics for files or projects

Canonical command: analyzeComplexity

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

Exact syntax

qzx analyzeComplexity <file_path> [recursive] [format] --json

Parameters

Name	Type	Required	Default	Description
file_path	str	Yes	Not declared	Path to the file or directory to analyze
recursive	bool	No	false	Whether to recursively analyze directories: -r/--recursive for unlimited, -rN/--recursiveN for N levels
format	str	No	"detailed"	Output format: "detailed" or "summary"

Input examples

qzx analyzeComplexity "main.py"

Analyze complexity of a single Python file

qzx analyzeComplexity "src/components" -r

Recursively analyze all code files in a directory

qzx analyzeComplexity "project/" -r2 "summary"

Generate a summary report analyzing up to 2 levels deep

For the complete structured payload, add --json: qzx analyzeComplexity <file_path> [recursive] [format] --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 analyzeComplexity "main.py" --json

{
    "success": true,
    "message": "Analyzes code complexity metrics for files or projects. In this illustrative example, the command completed successfully.",
    "details": {
        "path": "C:\\project\\example.txt",
        "files_seen": "C:\\project\\example.txt",
        "files_analyzed": "C:\\project\\example.txt",
        "format": "json",
        "analyses": [
            {
                "name": "example",
                "status": "ok"
            }
        ]
    },
    "report": "Analysis complete.\nNo blocking issues were found."
}

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": {
            "oneOf": [
                {
                    "type": "object",
                    "properties": {
                        "path": [],
                        "files_seen": [],
                        "files_analyzed": [],
                        "format": [],
                        "analyses": []
                    },
                    "additionalProperties": true
                },
                {
                    "type": "object",
                    "properties": {
                        "path": [],
                        "files_seen": [],
                        "files_analyzed": {
                            "type": "integer"
                        },
                        "supported_extensions": []
                    },
                    "additionalProperties": true
                }
            ]
        },
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "report": []
    },
    "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/development/analyze_complexity.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 development category. Compare them to choose the operation that best fits your task.

Explore all QZX commands