Skip to content

CLI reference

Command-line interface for EzCompiler โ€” project initialization, file generation, and build automation.

๐Ÿ’ป Usage

ezcompiler [OPTIONS] COMMAND [ARGS]...

โš™๏ธ Global options

Option Short Description
--version Show the version and exit
--help Show help and exit
--verbose Enable verbose output
--quiet Suppress non-error output

๐Ÿ“‹ Commands

Command Description
init Initialize a new project interactively
generate config Generate a configuration file
generate setup Generate a setup.py from a configuration file
generate version Generate a Windows version information file
generate template Generate a template file with optional mockup data

init

Initialize a new EzCompiler project with interactive prompts.

ezcompiler init

Guides through: project name, main script, output directory, compiler selection, dependencies, and files to include.


generate config

Create a configuration file.

ezcompiler generate config --project-name "MyApp" --main-file "main.py"
Option Required Default Description
--project-name Yes โ€” Project name
--main-file Yes โ€” Main Python file
--version No "1.0.0" Project version
--output No "ezcompiler.yaml" Output file path
--format No yaml Output format (yaml or json)

generate setup

Generate a setup.py from a configuration file.

ezcompiler generate setup --config ezcompiler.yaml
Option Required Default Description
--config Yes โ€” Path to configuration file
--output No "setup.py" Output file path

generate version

Generate a Windows version information file.

ezcompiler generate version --config ezcompiler.yaml
Option Required Default Description
--config Yes โ€” Path to configuration file
--output No "version.txt" Output file path

generate template

Generate a template file with optional mockup data.

ezcompiler generate template --type config --mockup
Option Required Description
--type Yes Template type: config, setup, or version
--mockup No Include sample data
--output No Output file path

๐Ÿงช Examples

# Show version
ezcompiler --version

# Initialize project interactively
ezcompiler init

# Generate a YAML configuration
ezcompiler generate config --project-name "MyApp" --main-file "main.py" --version "2.0.0"

# Generate setup.py
ezcompiler generate setup --config ezcompiler.yaml

# Generate version information file
ezcompiler generate version --config ezcompiler.yaml --output version_info.txt

# Generate config template with sample data
ezcompiler generate template --type config --mockup