qzx scanProject

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 scanProject --json

{
    "success": true,
    "message": "Scans a project root to identify technologies, scripts, configuration files, and missing environment keys. In this illustrative example, the command completed successfully.",
    "configuration_files": [
        "pyproject.toml",
        "package.json"
    ],
    "environment_diagnostics": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "package_json": "Example value",
    "package_managers": [
        "pnpm",
        "pip"
    ],
    "php_dependencies": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "project_path": "C:\\project\\example.txt",
    "project_types": [
        "Python",
        "Node.js"
    ],
    "python_dependencies": [
        "psutil",
        "PyYAML"
    ]
}

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "configuration_files": [],
        "environment_diagnostics": [],
        "error": {
            "type": "string"
        },
        "package_json": [],
        "package_managers": [],
        "php_dependencies": [],
        "project_path": [],
        "project_types": [],
        "python_dependencies": []
    },
    "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.