Building CG DevX CLI

This will allow you to build CG DevX CLI from sources

Pre-requisites

You should have:

  • python 3.10 + pip
  • poetry 1.6.*

If you don't have poetry installed, please follow official installation instructions here.

Preparing the environment

# Assumed directory: GITROOT/tools
# NOTE: Poetry configuration and lock files are stored in the 'cli' directory.

# To install dependencies, use:
poetry install

# Activate the virtual environment with:
# By default, Poetry creates a virtual environment in {cache-dir}/virtualenvs
poetry shell

To find more on poetry commands, please see.

Building the CLI tool

To build the CLI tool, please run PyInstaller directly:

# Current directory: GITROOT/tools
python -m PyInstaller --onefile cli/__main__.py --name cgdevxcli

or via the python script:

# Current directory: GITROOT/tools
poetry run build

After that you can use and distribute the cgdexvcli binary located at GITROOT/dist/cgdevxcli.