development · Command reference
qzx bootstrapProject
What it does
Initializes a project from scratch, setting up directories, virtual environments, dependencies, .env files, and git hooks
Canonical command: bootstrapProject
Accepted aliases: None
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
Can mutate state
Documented dry-run parameter
May invoke native programs
No documented network use
No inherent elevation requirement
Before mutation, QZX creates a recovery archive; --dangerously-bypass-approvals-and-sandbox/--yolo explicitly skips it.
This safety classification was reviewed against implementation digest sha256:a62f0f5b7ae298d5492ee6f8a9bcda8707acc0486ec5ead645a6d88d97edb7bd on 2026-07-24.
Exact syntax
qzx bootstrapProject [path] [tech] [dry_run] --jsonParameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| path | str | No | "." | Path to the directory to bootstrap (default: '.') |
| tech | str | No | Not declared | Technology stack: python, node, rust, php, cpp, typescript (optional, auto-detected if not specified) |
| dry_run | bool | No | true | If True, simulate the bootstrap process without writing/running commands (default: True) |
Input examples
qzx bootstrapProjectPreview bootstrap of the current project
qzx bootstrapProject --tech python --dry_run falseBack up and bootstrap a Python project
qzx bootstrapProject --dry_run TrueSimulate the bootstrap process
For the complete structured payload, add --json: qzx bootstrapProject [path] [tech] [dry_run] --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 bootstrapProject --json
{
"success": true,
"message": "Initializes a project from scratch, setting up directories, virtual environments, dependencies, .env files, and git hooks. In this illustrative example, the command completed successfully.",
"details": {
"detected_tech": "Example value",
"steps_executed": "Example value",
"environment_created": "Example value",
"dependencies_installed": true,
"env_file_created": "C:\\project\\example.txt",
"hooks_configured": "Example value",
"migrations_executed": 42.7,
"tests_result": "Example value",
"dry_run_mode": 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"
},
"details": {
"type": "object",
"properties": {
"detected_tech": [],
"steps_executed": [],
"environment_created": [],
"dependencies_installed": [],
"env_file_created": [],
"hooks_configured": [],
"migrations_executed": [],
"tests_result": [],
"dry_run_mode": []
},
"additionalProperties": true
},
"error": {
"type": "string"
}
},
"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: requires an isolated disposable target.
Evidence and provenance
- Implementation
- src/qzx/commands/development/bootstrap_project.py
- Documentation channel
- Development documentation 0.2.2.0.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
- Availability
- 0.2.2.0.2 or earlier
Keep exploring
Related commands
These commands also belong to the development category. Compare them to choose the operation that best fits your task.
qzx auditRepositoryRuns security and quality audits on a Git repository (secrets, large files, duplicates, .gitignore compliance, licenses)qzx cleanDevCachesScans recursively for heavy development caches/dependencies (node_modules, __pycache__, dist) and purges themqzx analyzeComplexityAnalyzes code complexity metrics for files or projectsqzx compareFilesCompares two files and reports their differences