CLI reference¶

ezqt is the command-line interface for EzQt App. It exposes project initialization, documentation serving, and utility commands.

💻 Usage¶

ezqt [OPTIONS] COMMAND [ARGS]...

⚙️ Global options¶

Option	Short	Description
`--version`	`-v`	Show the version and exit
`--help`	`-h`	Show help message and exit

📋 Commands¶

Command	Description
`init`	Initialize project assets and configuration
`create`	Create a new project from a template
`convert`	Convert translation `.ts` files to Qt binary `.qm` format
`docs`	Serve the documentation locally
`info`	Display package and runtime information

🔧 `ezqt init`¶

Initialize project assets and configuration.

ezqt init [OPTIONS]

Option	Short	Description
`--force`	`-f`	Force overwrite of existing files
`--verbose`	`-v`	Verbose output
`--no-main`		Skip `main.py` generation

🔧 `ezqt create`¶

Create a new project from a template.

ezqt create [OPTIONS]

Option	Short	Description
`--template`	`-t`	Template type
`--name`	`-n`	Project name
`--verbose`	`-v`	Verbose output

🔧 `ezqt convert`¶

Convert translation .ts files to Qt binary .qm format.

ezqt convert

No options.

🔧 `ezqt docs`¶

Serve the documentation locally.

ezqt docs [OPTIONS]

Option	Short	Description
`--serve`	`-s`	Start local dev server
`--port`	`-p`	Port number (default: `8000`)

🔧 `ezqt info`¶

Display package and runtime information.

ezqt info

No options.

⚙️ Environment variables¶

Variable	Description
`EZQT_VERBOSE`	Enable verbose mode by default for all commands
`EZQT_PROJECT_ROOT`	Override the project root directory detection
`EZQT_THEME_DIR`	Custom path to the themes directory
`EZQT_NO_COLOR`	Disable colored CLI output

🧪 Examples¶

# Initialize a new project
ezqt init --verbose

# Bootstrap with force overwrite
ezqt init --force --no-main

# Create a project from the basic template
ezqt create --template basic --name my_app

# Serve documentation on a custom port
ezqt docs --serve --port 8080

# Convert translation files
ezqt convert

# Display runtime info
ezqt info

Troubleshooting¶

Issue	Solution
`ezqt` not found	Reinstall package in active environment: `pip install -e ".[dev]"`
Init fails in wrong folder	Run command from project root
Docs serve fails on port	Use another `--port` value

CLI source

CLI implementation: src/ezqt_app/cli/main.py