system · Command reference

`qzx currentDir`

What it does

Shows the current working directory

Canonical command: currentDir

Accepted aliases: pwd, cwd, dir, where, location

Case-sensitive: no

Included in the published package

Available in PyPI 0.2.2.0.2. This page documents the 0.2.2.0.2 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 against implementation digest sha256:78f63dac5ad0d222806d499c16cc3efc158c9c17bf9c9b54b9be17334b73cb93 on 2026-07-24.

Exact syntax

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

Parameters

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 currentDir

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

qzx currentDir --size

Adds recursive size and descendant totals in one filesystem scan

qzx currentDir --details --limit 20

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

qzx dir false

Shows only the current directory name as the displayed path

For the complete structured payload, add --json: qzx currentDir [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 currentDir --json

{
    "success": true,
    "message": "Shows the current working directory. In this illustrative example, the command completed successfully.",
    "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"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "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/current_dir.py
Tests: tests/test_system_commands/test_current_dir.py
Documentation channel: Development documentation 0.2.2.0.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
Availability: 0.2.2.0.2 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