qzx getGitStatus

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

{
    "success": true,
    "message": "Provides a structured summary of the Git repository state (branch, remote, changes, recent commits). In this illustrative example, the command completed successfully.",
    "branch": "main",
    "changes": {
        "staged": "Example value",
        "modified": "Example value",
        "untracked": "Example value",
        "deleted": "Example value",
        "renamed": "Example value"
    },
    "changes_summary": {
        "staged_count": 3,
        "modified_count": 3,
        "untracked_count": 3,
        "deleted_count": 3,
        "total_changes": 3
    },
    "is_git_repository": true,
    "recent_commits": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "remotes": [
        {
            "name": "origin",
            "url": "https://github.com/example/project.git"
        }
    ],
    "repo_path": "C:\\project\\example.txt",
    "sync_status": {
        "ahead": "Example value",
        "behind": "Example value",
        "in_sync": true
    },
    "tracking_branch": "Example value"
}

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "branch": [],
        "changes": {
            "type": "object",
            "properties": {
                "staged": [],
                "modified": [],
                "untracked": [],
                "deleted": [],
                "renamed": []
            },
            "additionalProperties": true
        },
        "changes_summary": {
            "type": "object",
            "properties": {
                "staged_count": [],
                "modified_count": [],
                "untracked_count": [],
                "deleted_count": [],
                "total_changes": []
            },
            "additionalProperties": true
        },
        "error": {
            "type": "string"
        },
        "is_git_repository": {
            "type": "boolean"
        },
        "recent_commits": [],
        "remotes": [],
        "repo_path": [],
        "sync_status": {
            "type": "object",
            "properties": {
                "ahead": [],
                "behind": [],
                "in_sync": {
                    "type": "boolean"
                }
            },
            "additionalProperties": true
        },
        "tracking_branch": []
    },
    "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.