Install CodeMRI® on Windows (pre-1.24.60)

Owned by Fletcher Hirtle
Jan 22, 2024
5 min read

To obtain a pdf version of these instructions, click the ellipse (...) at the top right of this page.

Table of Contents

Information

The CodeMRI® executable CMRI will create a Vault at your chosen location. Within the vault CMRI will designate Projects & Systems; projects being analogous to codebases and systems to snapshots. The source code will be stored in the project-system hierarchy. CMRI will also generate reports within the vault location.

Preface

CodeMRI® Platform (CMRI) is an installable command line utility for Windows & Linux that generates Silverthread CodeMRI® Care and Silverthread CodeMRI® Portfolio reports for software systems. It is intended for use on code bases of any size and generates reports in xlsx format. All instructions imply you are working in a command-line environment. 

Installation Instructions

Upgrade Notice

Prior to version 1.24.27, CodeMRI® Platform required a separate installation of Understand. Beginning with CodeMRI® Platform 1.24.27, this requirement has been lifted. You may uninstall Understand via the Windows Add/Remove Programs settings pane.

1. Prepare for Install

  • Open up the start menu, type Computer, then press Enter.

  • Look under "Devices and Drives". Make sure you have a volume with at least 40GB available storage + 5GB per scan to be performed.

  • If there is enough storage, proceed to the installation.

2. Download & Install CodeMRI® Platform (CMRI)

2.1 Acquire CodeMRI® (CMRI)

  • If you haven't already done so, navigate to CodeMRI.com and sign in. If this is a new account, click sign up.  Enter your email address and password.  Navigate to your email client and validate the email. This email address will become the username for this account.

  • Navigate to the Downloads page https://codemri.com/installers/

2.2 Unpack CodeMRI® (CMRI)

  • Download the CMRI Platform - Windows file.

  • Extract the downloaded zip file.

  • Run setup.exe within the new CMRI Platform folder. The installation process will begin.

    • It may take a moment for the setup to begin.

    • You may receive a Windows Defender warning, if so, click the "More Info" option and select "Run anyway".

  • Read and accept the license agreement.

  • Select the path where CMRI will be installed or leave as default.

  • Click "Next" to install CMRI and complete the installation process. The progress bar will stop moving for a few minutes about halfway through the installation process. Do not terminate the installer during this time, as the installer has not stalled.

3. Start CodeMRI®

Once you receive the license code from Silverthread support, enter the code as instructed in the reply and re-run job run produce_reports.