Windows CLI Installation

Overview

This topic covers installation of Windows IPLM CLI for Windows 10 and Windows 11.

Before you begin

  • Have the IPLM Server URL for your IPLM system ready as you will be prompted to enter it during the installation process.

Installation choices

Windows 11

Install using MSI

  1. On a Windows 11 machine, download the installer.

  2. Run the msi installer.

  3. Enter the required configuration information when prompted.

    When the install completes, a configuration file (piclient.conf) is saved into C:\[INSTALL_LOCATION]\config.

Configuration

Environment variables are set by P4D.

To change the variables, perform a Windows search for "Environment Variables."

  • P4CONFIG
    Identifies the name of the Perforce configuration file for the P4CLIENT info for each workspace. 

  • P4PORT
    Identifies the Perforce server to run p4 commands with. Needs to be set to be able to load workspaces with Perforce.

Current Limitations Under Windows 11

  • Limited support of some IP project properties: 
    • --path: must be represented in the IP in Unix format (ex: --path $LIB/$IP as opposed to --path $LIB\$IP) 
    • --unix_group: there is currently no support for windows with this project property
  • Workspace Management and DMs: 
    • There is only support for PWM (without PiCache) as a workspace manager 
    • There is only support for Perforce (no FS or SVN) as a DM

Uninstall

You can uninstall IPLM CLI either by clicking the installer, then selecting Uninstall, or by navigating to Settings > Installed Apps > Perforce IPLM. Follow the prompts to uninstall.

Windows 10

Install using CMD

  1. On Windows 10 Platform, download the following file:
    mdx-picli-3.0.6-21.05.03_16.42.zip

  2. Unzip the above file in an empty folder
  3. Open a cmd window

  4. Add the above folder into the PATH environment variable

    > set PATH=%PATH%;<the folder where the zip was decompressed>

  5. Configure the necessary environment variables, mentioned below

  6. Run a Perforce IPLM command

    > pi <Pi command option>

Configuration

  • MDX_CONFIG_DIR
    Identifies which directory should be used to find configuration files, such as piclient.conf, etc. If this variable is not set, the default is set to <Home>/.methodics

    set MDX_CONFIG_DIR=<Path to Directory>

  • MDX_PI_SERVER
    Identifies the Perforce IPLM server to run pi commands with. This can also be set in the piclient.conf file. 

    set MDX_PI_SERVER=http://<PiServer>:8080

  • P4PORT
    Identifies the Perforce server to run p4 commands with. Needs to be set to be able to load workspaces with Perforce.

    set P4PORT=<P4 Server>:<P4 PORT>

  • P4CONFIG
    Identifies the name of the Perforce configuration file for the P4CLIENT info for each workspace. 

    set P4CONFIG=.p4config

  • P4IGNORE
    Identifies the p4ignore file to be used. If this variable is not set, the default is to search for .p4ignore in the configuration directory (MDX_CONFIG_DIR)

    set P4IGNORE=<Path to p4ignore file>

Current Limitations Under Windows 10

  • Limited support of some IP project properties: 
    • --path: must be represented in the IP in Unix format (ex: --path $LIB/$IP as opposed to --path $LIB\$IP) 
    • --unix_group: there is currently no support for windows with this project property
  • Workspace Management and DMs: 
    • There is only support for PWM (without PiCache) as a workspace manager 
    • There is only support for Perforce (no FS or SVN) as a DM
  • Unicode: 
    • IPLM CLI on Windows runs in ASCII mode. However, there is support for unicode for Unix machines. This means that there may be objects in the database with names that will not be rendered properly when viewed on a Windows client