Skip to main content

development · Command reference

qzx getGitStatus

What it does

Provides a structured summary of the Git repository state (branch, remote, changes, recent commits)

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

No elevation required by design

This safety classification was reviewed by OpenAI GPT-5.6 Pro against implementation digest sha256:96be8082239a867205cc1f4997a24a381e15557db9702280fc411c5528ff301b on 2026-08-25.

Exact syntax

qzx getGitStatus [repo_path] --json

Parameters

Swipe or use the horizontal scrollbar to see every column.

NameTypeRequiredDefaultDescription
repo_pathstrNo"."Path to the directory to scan (defaults to the current working directory)

Input examples

qzx getGitStatus

Show git status for the current directory

qzx getGitStatus C:/some/path

Show git status for the repository at C:/some/path

For the complete structured payload, add --json: qzx getGitStatus [repo_path] --json

Observed output example

Captured with QZX 0.2.2.0.8 on Windows 11; exit code 0. Host-dependent values and duration can vary.

Example command: qzx getGitStatus ../artifacts/qzx-evidence/git-status --json

{
    "success": true,
    "is_git_repository": true,
    "repo_path": "C:\\Team Dropbox\\Valis Idealis\\Ale\\Programacion\\QZX - Quick Zap Exchange\\artifacts\\qzx-evidence\\git-status",
    "branch": "main",
    "tracking_branch": null,
    "sync_status": {
        "ahead": 0,
        "behind": 0,
        "in_sync": true
    },
    "changes": {
        "staged": [
            "staged.txt"
        ],
        "modified": [
            "tracked.txt"
        ],
        "untracked": [
            "untracked.txt"
        ],
        "deleted": [],
        "renamed": []
    },
    "changes_summary": {
        "staged_count": 1,
        "modified_count": 1,
        "untracked_count": 1,
        "deleted_count": 0,
        "total_changes": 3
    },
    "remotes": {
        "origin": {
            "fetch": "https://example.invalid/qzx-evidence.git",
            "push": "https://example.invalid/qzx-evidence.git"
        }
    },
    "recent_commits": [
        {
            "hash": "cf86262",
            "author": "QZX Evidence Fixture",
            "date": "2026-08-08",
            "subject": "Create controlled QZX evidence fixture"
        }
    ],
    "message": "Git Repository Status for 'C:\\Team Dropbox\\Valis Idealis\\Ale\\Programacion\\QZX - Quick Zap Exchange\\artifacts\\qzx-evidence\\git-status':\n- Branch: main\n- Tracking: None\n- Uncommitted Changes: Staged=1, Modified=1, Untracked=1, Deleted=0\n- Latest Commit: [cf86262] Create controlled QZX evidence fixture by QZX Evidence Fixture (2026-08-08)",
    "meta": {
        "command": "getGitStatus",
        "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": 1262.381,
        "schema_version": 1
    }
}
View the JSON result contract
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message",
        "meta"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "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
        },
        "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.

{
    "success": false,
    "error": "Path '../artifacts/qzx-evidence/git-status-missing' does not exist.",
    "message": "Path '../artifacts/qzx-evidence/git-status-missing' does not exist.",
    "meta": {
        "command": "getGitStatus",
        "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": 3.312,
        "schema_version": 1
    }
}

Captured command: qzx getGitStatus ../artifacts/qzx-evidence/git-status-missing --json

Evidence workflow: captured and digest-validated.

Evidence and provenance

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 development category. Compare them to choose the operation that best fits your task.

Explore all QZX commands