system · Command reference

`qzx getCurrentDirectory`

What it does

Shows the current working directory

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.6a11. This page documents the 0.2.2.0.6a11 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 by OpenAI Codex (authorized project audit) against implementation digest sha256:417593f0f94d1b8d89e6ebe938f9820f3968ffbd7afb8b9090bc4b652f942791 on 2026-07-30.

Exact syntax

qzx getCurrentDirectory [full] [size] [details] [limit] --json

Parameters

Swipe or use the horizontal scrollbar to see every column.

Name	Type	Required	Default	Description
full	bool	No	true	Show the full path (true) or only the directory name (false)
size	bool	No	false	Recursively calculate logical directory size and descendant file/directory totals
details	bool	No	false	Include a recursive analysis, immediate entry preview, extension summary, largest/recent files, permissions, and filesystem capacity
limit	int	No	10	Maximum entries in each details list (1-100, default: 10)

Input examples

qzx getCurrentDirectory

Shows the current path and counts files/directories at that level

qzx getCurrentDirectory --size

Adds recursive size and descendant totals in one filesystem scan

qzx getCurrentDirectory --details --limit 20

Returns a rich directory analysis with up to 20 items per list

qzx getCurrentDirectory --full false

Shows only the current directory name as the displayed path

For the complete structured payload, add --json: qzx getCurrentDirectory [full] [size] [details] [limit] --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 getCurrentDirectory --json

{
    "success": true,
    "message": "Shows the current working directory. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "getCurrentDirectory",
        "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": 0,
        "schema_version": 1
    },
    "analysis_requested": {
        "size": false,
        "details": false,
        "list_limit": 20
    },
    "contents": {
        "scope": "current_level",
        "entry_count": 15,
        "file_count": 11,
        "directory_count": 4,
        "hidden_count": 2,
        "is_empty": false,
        "immediate_files_size_bytes": 245760,
        "immediate_files_size_formatted": "240.00 KiB"
    },
    "current_dir": "C:\\project",
    "details": {
        "received_limit": "Example value",
        "minimum": 3,
        "maximum": 3
    },
    "directory_name": "project",
    "displayed_path": "C:\\project\\example.txt",
    "full_path": "C:\\project",
    "home_relative_path": "~\\project",
    "parent_directory": "C:\\",
    "recursive_analysis": true
}

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
        },
        "analysis_requested": {
            "type": "object",
            "properties": {
                "size": [],
                "details": [],
                "list_limit": []
            },
            "additionalProperties": true
        },
        "contents": [],
        "current_dir": [],
        "details": {
            "type": "object",
            "properties": {
                "received_limit": [],
                "minimum": {
                    "type": "integer"
                },
                "maximum": {
                    "type": "integer"
                }
            },
            "additionalProperties": true
        },
        "directory_name": [],
        "displayed_path": [],
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "full_path": [],
        "home_relative_path": [],
        "parent_directory": [],
        "recursive_analysis": []
    },
    "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/system/get_current_directory.py
Tests: tests/test_system_commands/test_get_current_directory.py
Documentation channel: Development documentation 0.2.2.0.6a11 · main · sha256:d1bf56371df81b2a79619d8219eed92ccf790be1584c528e211381ca7aa85302
Availability: 0.2.2.0.6a11 or earlier

Keep exploring

These commands also belong to the system category. Compare them to choose the operation that best fits your task.

Explore all QZX commands