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 by removing the /opt/understand directory.

1. Prepare for Install

Create and or navigate to the directory in which CodeMRI® (CMRI) will be installed.
Verify there is enough storage to install CMRI and store the codebases to be analyzed.
- System storage can be revealed by typing df -h into the command line.
If there is enough storage in the desired location, proceed to the installation.

2. Download & Install CodeMRI^® (CMRI)

2.1 Acquire CodeMRI^®(CMRI)

Navigate to CodeMRI.com and sign In. If this is a new account, click sign up. 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/ and Download the CodeMRI Platform - Linux ZIP File.
- The CMRI Platform download link is protected, so you can't copy & paste the link from CodeMRI.com into the CLI.
- Use a system that can browse CodeMRI.com, navigate to the Downloads page and download the CodeMRI Platform - Linux zip file.
- Either physically move the zip to your Linux partition or copy it to your Linux partition or virtual machine using the scp command
  scp -r -i ~/path/to/<CMRI Platform zip filename> REMOTE_USERNAME@IP_ADDRESS:~/REMOTE_PATH

Installation will fail if the install path contains any spaces.

Please be sure to extract the installer into a path whose name contains no spaces. For example, /opt/cmri. If the installation path contains any spaces, the installation may fail or CodeMRI may fail to work properly.

2.2 Unpack CodeMRI^®(CMRI)

Navigate to the directory containing the CMRI Platform ZIP File & decompress the zip file using the command:
$ unzip <CMRI Platform zip filename>

If no pre-existing unzip program exists on the system, run apt-get install unzip for Debian based systems or yum install unzip bzip2 libxcb libXext ncurses-compat-libs for Redhat (RHEL)/CentOS based systems.

Run setup.sh in the new CMRI Platform folder with using the command:
$ ./setup.sh

a. At this point the installation process will begin.

CMRI Versions prior to 1.24.50 will need to run the setup script with sudo.

Read and type accept to accept the license agreement.
- Upon completion, the following message should be displayed:
  CodeMRI is now installed and configured. Please reload your shell or log out then back in.
  You must log out and log in again to use CMRI.

3. Start CodeMRI^®

CMRI should now be operational, start Command Prompt and run the command cmri --help. You should see the following output on your terminal:

Welcome the CodeMRI(R) CLI Reference. The CodeMRI(R) Command-line Interface (CLI) provides an easy to use interface for administering and using your CodeMRI(R) product. To get started, see General Invocation.

Press q then enter to return to the terminal.

Before using CMRI, you will need to create a vault. It's recommend to create a folder called “vault”.
- Using CMRI in the installation directory will cause complications, you must create the vault in a different directory.
- Navigate to the directory where you want your vault to be created. Alternatively, specify the directory path using the --vault flag for the command below.
- Run cmri vault create and answer the prompts given.

Contact information for vault creation does not need to match the license email.

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 ProjectName --version 47.0 --origin "/path/to/code/"
Successfully added new system to selected project(s).
==================================
1 projects and 1 systems selected.

Note that code (system) added can be compressed or uncompressed.

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

Update from previous version

Uninstall the existing CMRI Platform.
Install the new version, using the installation guide above

- Skip the process of creating a vault and logging in if there is an existing vault.

Installation Instructions

Upgrade Notice

1. Prepare for Install

2. Download & Install CodeMRI® (CMRI)

2.1 Acquire CodeMRI®(CMRI)

2.2 Unpack CodeMRI®(CMRI)

3. Start CodeMRI®

Update from previous version

2. Download & Install CodeMRI^® (CMRI)

2.1 Acquire CodeMRI^®(CMRI)

2.2 Unpack CodeMRI^®(CMRI)

3. Start CodeMRI^®