Versions Compared

Old Version 24

changes.mady.by.user Dustin Haxton

Saved on

compared with

New Version 25

changes.mady.by.user Brandon Smith

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Installation Instructions

Info

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.

...

Multiexcerpt macro
namevault create
fallbackfalse

  • 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.

Multiexcerpt macro
nameWould you like to create a new vault...
fallbackfalse

  • 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 SystemName --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.

Multiexcerpt include macro
nameWhat would you like to name the system...
pageInstall CodeMRI® on Windows

...