development · Command reference

`qzx planProjectBootstrap`

What it does

Builds a selectable project bootstrap plan without writing files, installing dependencies, creating secrets, or running migrations

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.9. This page documents the 0.2.2.0.9 alpha development checkout.

Behavior and built-in protections

Inspects without changing state

Direct execution for this operation

Works without invoking native programs

Works without network access

No elevation required by design

Builds a selectable plan only. It neither writes files nor runs the listed native commands, dependency installers, tests, hooks, secret creation, or database migrations. Each proposed step explicitly classifies potential network, sensitive-data, filesystem, and external-state effects; ambiguous or absent technology detection fails closed.

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

Exact syntax

qzx planProjectBootstrap [path] [tech] [components] --json

Parameters

Swipe or use the horizontal scrollbar to see every column.

Name	Type	Required	Default	Description
path	str	No	"."	Project directory to inspect or plan
tech	str	No	Not declared	Explicit stack: python, node, typescript, rust, php, or cpp. Required when manifests do not identify exactly one stack
components	str	No	"all"	Comma-separated plan sections: structure, environment, dependencies, configuration, hooks, database, checks, or all

Input examples

qzx planProjectBootstrap . --tech python

Plan every Python bootstrap component without writes

qzx planProjectBootstrap ./web --tech typescript --components structure,dependencies,checks

Plan selected TypeScript bootstrap components

qzx planProjectBootstrap ./existing-project

Detect one unambiguous stack from existing manifests

For the complete structured payload, add --json: qzx planProjectBootstrap [path] [tech] [components] --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 planProjectBootstrap . --tech python --json

{
    "success": true,
    "message": "Builds a selectable project bootstrap plan without writing files, installing dependencies, creating secrets, or running migrations. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "planProjectBootstrap",
        "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."
    }
}

View the JSON result contract

{
    "type": "object",
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "details": {
            "type": "object",
            "additionalProperties": true
        },
        "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
        }
    },
    "additionalProperties": true,
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "required": [
        "message",
        "meta",
        "success"
    ]
}

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/development/plan_project_bootstrap.py
Tests: tests/test_development_commands/test_plan_project_bootstrap.py
Documentation channel: Development documentation 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
Availability: 0.2.2.0.9 or earlier

Keep exploring

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

Explore all QZX commands