Installation

Pre-Requisites

1. Please ensure at-least Python 3.5 is available. The preferred/recommended version is 3.8.
2. Download the latest release and decompress the release (OR) clone/fork from this reposiroty.

Installation as a CLI Command

1. To Install CxMaintain as cli utility, run pip install .\CxMaintain on Microsoft Windows.

Installing on OS X or Linux

1. CxMaintain can be installed on Windows or Linux or OS X. However, if your Checkmarx Servers storing the source directories are exclusively Windows, Installing on OS X and Linux, Only the --dryrun option will work and provide a list of directories that can be deleted.

Creating an executable on Microsoft Windows

1. To create an exe on Windows, run pip install PyInstaller.
2. Then navigate to the CxMaintain\cxmaintain directory.
3. Run pyinstaller cxmaintain.py
4. Executables with required dynamic library files are then created in a new directory dist
5. You can now use the .exe to run as a windows Service or as a Scheduled task