跳到主要内容

开发 · 命令参考

qzx getGitStatus

作用

提供结构化的 Git 状态摘要:分支、远程仓库、更改和近期提交。

命令成熟度:Alpha

可用于真实使用和反馈,但其接口与行为仍可能继续演进。 这是当前开发 checkout 的评估。未来每个不可变发布标签都会保留该版本中包含的准确评估。 可在 PyPI 0.2.2.0.9 使用。文档对应 alpha checkout 0.2.2.0.9。

行为与内置保护

只检查,不改变状态

此操作直接执行

需要时使用原生工具

无需网络即可运行

设计为无需提权即可运行

此安全分类由 OpenAI GPT-5.6 Pro 于 2026-08-25 对照实现摘要 sha256:96be8082239a867205cc1f4997a24a381e15557db9702280fc411c5528ff301b 审阅。

准确语法

qzx getGitStatus [repo_path] --json

参数

滑动或使用横向滚动条查看所有列。

名称类型必填默认值描述
repo_pathstr"."要分析的目录路径(默认:当前工作目录)

输入示例

qzx getGitStatus

显示当前目录的 Git 状态

qzx getGitStatus C:/some/path

显示 C:/some/path 中仓库的 Git 状态

要获得完整结构化载荷,请添加 --json: qzx getGitStatus [repo_path] --json

实测输出示例

使用 Windows 11 上的 QZX 0.2.2.0.9 捕获;退出码 0。依赖主机的值和耗时可能不同。

示例命令: 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": 872.168,
        "schema_version": 1
    }
}
查看 JSON 结果契约
{
    "$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
}

错误与限制

公开契约要求失败时返回 success=false 和具有描述性的 message。此目录尚未为每个命令声明专门的错误分类;请检查结果,不要推断不存在的错误码。

QZX 仍处于 alpha 阶段。可选依赖、权限和主机能力可能影响结果。

{
    "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": 8.048,
        "schema_version": 1
    }
}

捕获的命令: qzx getGitStatus ../artifacts/qzx-evidence/git-status-missing --json

证据流程:已捕获并通过摘要验证。

证据与来源

文档渠道
开发文档 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
可用性
0.2.2.0.9 或更早

继续探索

这些命令同样属于 开发 类别。对比它们,选择最适合解决任务的操作。

浏览所有 QZX 命令