メインコンテンツへ移動

開発 · コマンドリファレンス

qzx getProjectTree

機能

配下のシンボリックリンクをたどらず、範囲を制限したツリーを ASCII と JSON で生成します。

コマンドの成熟度: Alpha

実際の利用とフィードバックに使えますが、インターフェースと動作はまだ変更される可能性があります。 これは現在の開発チェックアウトに対する評価です。今後の各不変リリースタグには、そのバージョンに含まれた正確な評価が保存されます。 PyPI 0.2.2.0.9 で利用できます。ドキュメントは alpha チェックアウト 0.2.2.0.9 に対応しています。

動作と組み込み保護

状態を変更せずに検査します

この操作は直接実行されます

ネイティブプログラムを呼び出さずに動作します

ネットワークを使わずに動作します

権限昇格なしで動作するよう設計されています

この安全分類は 2026-08-25 に OpenAI GPT-5.6 Pro が実装ダイジェスト sha256:5ccd75d947b974cd586e89b171111614cb66a656e219b1152a344ec058f28aad と照合してレビューしました。

正確な構文

qzx getProjectTree [dir_path] [max_depth] [exclude_dirs] [include_files] [max_entries] --json

パラメータ

スワイプするか横スクロールバーを使って、すべての列を表示してください。

名前型必須既定値説明
dir_pathstrいいえ"."表示するディレクトリ (既定値: 現在のディレクトリ)
max_depthintいいえ2子孫の最大深度。0～64
exclude_dirsstrいいえ".git,.idea,.next,.nuxt,.venv,.vscode,__pycache__,artifacts,build,dist,env,node_modules"除外するディレクトリ名をカンマ区切りで指定。比較は大文字小文字を区別しません
include_filesboolいいえtrueディレクトリに加えて通常ファイルも列挙します。リンクは常に表示しますが、たどりません
max_entriesintいいえ10000保持する子孫の最大件数。1～100000 (既定値: 10000)

入力例

qzx getProjectTree

現在のプロジェクトを子孫 2 階層まで表示

qzx getProjectTree src 3

src のツリーを子孫 3 階層まで表示

qzx getProjectTree . 2 .git,node_modules false --max_entries 500

最大 500 のディレクトリまたはリンクを表示し、2 つの名前を除外

完全な構造化ペイロードを取得するには --json を追加します: qzx getProjectTree [dir_path] [max_depth] [exclude_dirs] [include_files] [max_entries] --json

代表的な出力例

この説明用 JSON は現在の実装が裏付ける結果コントラクトから生成されています。記録された実行だと主張せず、コマンドが返し得る内容を示します。値は入力、マシン、権限、オプションツールによって変わります。

例のコマンド: qzx getProjectTree --json

{
    "success": true,
    "message": "Generates one bounded ASCII and JSON directory tree without following descendant symbolic links. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "getProjectTree",
        "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
    },
    "details": {
        "summary": "Additional structured context is included here."
    },
    "dir_path": "C:\\project\\example.txt",
    "exclude_dirs": [
        ".git",
        "node_modules",
        "__pycache__"
    ],
    "include_files": true,
    "max_depth": "Example value",
    "max_entries": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "tree_structure": {
        "name": "project",
        "children": [
            {
                "name": "src",
                "type": "directory"
            }
        ]
    },
    "tree_text": "project/\n└── src/\n    └── example.py",
    "warnings": [
        {
            "name": "example",
            "status": "ok"
        }
    ]
}
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
        },
        "details": [],
        "dir_path": [],
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "exclude_dirs": [],
        "include_files": [],
        "max_depth": [],
        "max_entries": [],
        "tree_structure": [],
        "tree_text": [],
        "warnings": []
    },
    "additionalProperties": true
}

エラーと制限

公開コントラクトでは失敗時に success=false と説明的な message が必要です。このカタログではまだコマンドごとのエラー分類を宣言していません。結果を確認し、存在しないコードを推測しないでください。

QZX は alpha 段階です。オプション依存関係、権限、ホスト機能によって結果が変わる場合があります。

証拠フロー: 決定論的な自動取得が可能。

証拠と出所

ドキュメントチャネル
開発ドキュメント 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
提供状況
0.2.2.0.9 以前

さらに探す

関連コマンド

これらのコマンドも 開発 カテゴリに属します。比較して、タスクに最適な操作を選んでください。

QZX の全コマンドを見る