Install CodeMRI® on Windows
To obtain a pdf version of these instructions, click the ellipse (...) at the top right of this page, then select Export > Export to PDF. The CodeMRI® executable Table of Contents
Information
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.
Installation Instructions
If you are installing a version older than 1.24.60, please see the instructions: Install CodeMRI® on Windows (pre-1.24.60)
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.2 Unpack CodeMRI® (CMRI)
Download the CMRI Platform - Windows file.
Run the CMRI installer 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 whether you want to install CodeMRI® for all users, or just the current user.
Select the path where CodeMRI® will be installed or leave as default.
Select the defaults for Advanced Options.
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®
Open a Windows Terminal or Command Prompt
If you did not do so during installation, put the
cmri\Scripts
directory on the PATH like this (the install directory may vary based on install choices, system configuration, and Windows Version):set PATH=%PATH%;"C:\Users\<username>\cmri\Scripts"
Create and select a project.
Start the shell by running
cmri shell
.Use the
project add
command to add a new project. CodeMRI® will select the project automatically after it is added.
> project add --name ProjectName
==================================
1 projects and 0 systems selected.
Create and select a system.
Use the
system add
command as shown below to add a new system. CodeMRI® will select the system automatically after it is added:
> system add --name SystemName --version 47.0 --origin "C:\Path\To\Code"
Successfully added new system to selected project(s).
==================================
1 projects and 1 systems selected.
Systems will be added to all selected projects. Ensure that only the desired projects are selected
Once you receive the license code from Silverthread support, enter the code as instructed in the reply and re-run job run produce_reports
.