Canonical catalog

QZX command documentation

This catalog documents the current development checkout and labels which capabilities are also present in the published PyPI 0.2.2.0.2 wheel. Command names are lower camel case and matching is case-insensitive.

Human output by default

Run qzx <command> for readable output. Use --json when a caller needs the complete structured object.

Channel is explicit

Each reference states whether the command is included in PyPI 0.2.2.0.2 or is available only from the 0.2.2.0.2 development checkout.

Evidence is scoped

Observed snapshots are shown only where captured. Other pages expose the shared base contract without inventing command-specific fields.

See complete transcriptsReview compatibilityUnderstand mutations and trust

CLI configuration

Environment variables

QZX reads these variables from the process environment. A value set in your shell affects commands launched from that session; removing it restores the default behavior.

Caution: QZX_SAFETY=YOLO disables a recovery barrier for every high-risk command in the session. Do not make it a permanent setting.

Safety and backups

Control protection before high-risk operations and the archive QZX creates before changing data.

QZX_SAFETYHigh risk

YOLO globally skips approval and safety backups for high-risk commands. It is equivalent to adding --yolo to each operation and should be limited to controlled sessions.

Values
YOLO
Default
protection enabled
QZX_BACKUPS_PATH

Changes where QZX stores automatic safety archives. The ~ prefix and system environment variables are expanded before creating the file.

Values
directory path
Default
~/QZX-Backups
QZX_BACKUPS_FORMAT

Selects the backup container. ZIP and TAR.GZ support compression; TAR stores the data uncompressed.

Values
ZIP · TAR.GZ · TAR
Default
ZIP
QZX_BACKUPS_COMPRESSION

Adjusts compression. Level 0 stores data without compression and 9 prioritizes smaller files; TAR always uses store effectively.

Values
store · fastest · fast · normal · maximum · 0–9
Default
fastest

Privacy, diagnostics, and integrations

Configure pseudonymous CLI telemetry, its local state, and optional services.

QZX_TELEMETRY

Use 0 to disable activation telemetry or 1 to enable it explicitly. QZX_TELEMETRY=1 takes precedence over DO_NOT_TRACK=1.

Values
0 · 1
Default
1 (enabled)
DO_NOT_TRACK

Disables telemetry when set to 1 unless QZX_TELEMETRY explicitly enables or disables it.

Values
1
Default
unset
QZX_TELEMETRY_STATE_DIR

Changes the location of the pseudonymous local telemetry state; useful for portable installations and tests.

Values
directory path
Default
operating-system data directory
QZX_TELEMETRY_DEBUG

Writes telemetry-delivery diagnostics to stderr. It does not change the command result.

Values
1 · true · yes · on · enabled
Default
disabled
GEMINI_API_TOKENSecret

Credential required by generateContent. It can also be loaded from a .env file; treat it as a secret and never publish or commit it.

Values
API token
Default
unset

Shell examples

Exported assignments last until you close the session or remove the variable. Replace the values to match your policy.

Linux / macOS / POSIX

QZX_TELEMETRY=0 qzx Welcome
export QZX_BACKUPS_FORMAT=TAR.GZ
export QZX_BACKUPS_COMPRESSION=fastest

Windows PowerShell

$env:QZX_TELEMETRY = "0"
$env:QZX_BACKUPS_FORMAT = "TAR.GZ"
$env:QZX_BACKUPS_COMPRESSION = "fastest"

93 documented commands

Indexable command reference

Each link opens an SSR page with syntax, parameters, availability, risks, examples, and implementation evidence.

93 included in PyPI 0.2.2.0.20 available only in development checkout 0.2.2.0.2

Development

File

Network

System