IPLM CLI commands cheat sheet
This page contains a convenient reference organized by topic with links to quickly get more information about the commands available on Perforce IPLM Command Line Interface (IPLM CLI).
Getting help
| Command | Definition |
|---|---|
| pi -h | Help on pi command options |
| pi <sub> -h | Help on pi sub-commands (pi ip -h) |
| pi settings | Show current Perforce IPLM configuration |
| pi whoami | Show currently logged in user |
| pi version | Show current Perforce IPLM version |
IP management
| Command | Definition |
|---|---|
| pi ip add | Create a new IP |
| pi ip attribute | Create and remove attributes on IPs and IPVs |
| pi ip copy | Copy an IP to a new IP or line |
| pi ip delete | Delete an existing IPV, IP, or line |
| pi ip diff | Compare two IPVs or an IPV to a workspace |
| pi ip edit | Edit an existing IP |
| pi ip list | List IPVs in Perforce IPLM (Catalog) |
| pi ip obliterate | Delete a referenced IP |
| pi ip properties | Set property values on an IP or an IPV |
| pi ip tree | View the IP Hierarchy |
| pi ip tree --list-new | Show new versions of resources in the IP Hierarchy |
Workspaces
| Command | Definition |
|---|---|
| pi ip diff | Compare two IPVs or an IPV to a workspace |
| pi ip load | Load an IPV Hierarchy into a workspace |
| pi ip local | Switch one or more IPVs to local mode |
| pi pi refer | Switch one or more IPVs to refer (cached) mode |
| pi ip publish | Publish an IPV to IPLM Cache without loading it in a workspace |
| pi release | Release a new IPV |
| pi update | Update an IPV in the workspace |
| pi ws delete | Delete a workspace |
| pi ws edit | Edit workspace resources (add/remove) and project properties |
| pi ws list | List workspaces |
| pi ws move | Move workspace to new location |
| pi ws refresh | Regenerate files and refer mode IPVs |
| pi ws status | Report status of a workspace |
| pi ws tree | View the current workspace hierarchy |
Aliases
| Command | Definition |
|---|---|
| pi alias add | Add an alias to an IPV |
| pi alias delete | Remove an alias from an IPV |
| pi alias lock | Lock an alias on an IPV |
| pi alias move | Move a unique alias to a new line/version |
| pi alias unlock | Unlock an alias on an IPV |
Library management
| Command | Definition |
|---|---|
| pi library add | Create new Library (admin only) |
| pi library attribute | Create/remove attributes on Libraries |
| pi library delete | Delete existing Library (admin only) |
| pi library edit | Edit an existing Library |
| pi library list | List existing Libraries |
Snapshots
| Command | Definition |
|---|---|
| pi snapshot add | Create new snapshot from a workspace |
| pi snapshot delete | Delete an existing snapshot |
| pi snapshot edit | Edit an existing snapshot |
| pi snapshot list | List existing snapshots |
| pi snapshot load | Load a workspace from a snapshot |
IP usage (Traceability)
| Command | Definition |
|---|---|
| pi ip usage | List IP/IPV usage in all projects |
| pi ws list --contains | Search workspaces for IPs and IPVs |
Metadata
| Command | Definition |
|---|---|
| pi label | Manage Library/IP labels |
| pi property add | Create a new property |
| pi property delete | Delete an existing property |
| pi property edit | Edit an existing property |
| pi property list | List properties |
| pi property-set add | Create a new property set |
| pi property-set attach | Attach a property set to an IP or Library |
| pi property-set delete | Delete an existing property set |
| pi property-set detach | Detach an existing property set |
| pi property-set edit | Edit an existing property set |
| pi property-set list | List existing property sets |
Saved queries
| Command | Definition |
|---|---|
| pi query add | Create a new Saved query |
| pi query attribute | Add an attribute to a Saved query |
| pi query delete | Delete a Saved query |
| pi query edit | Edit a Saved query |
| pi query list | List Saved queries |
Access
| Command | Definition |
|---|---|
| pi login | Log into Perforce IPLM. |
| pi logout | Log out of Perforce IPLM. |
| pi passwd | Change a local user's password. |
Permissions
| Command | Definition |
|---|---|
| pi perm add | Add permissions to objects, keep existing |
| pi perm delete | Remove permissions from objects |
| pi perm list | List permissions on objects |
| pi perm set | Set permissions on object, remove existing |
Events
| Command | Definition |
|---|---|
| pi subscription edit | Edit user/group subscriptions |
| pi subscription list | List user/group subscriptions |
Administration
| Command | Definition |
|---|---|
| pi dm | Manage available IP DM types |
| pi dm add | Add a new DM |
| pi dm delete | Delete an existing DM |
| pi dm edit | Edit an existing DM |
| pi dm list | List existing DMs |
| pi group | Manage Perforce IPLM groups |
| pi group add | Add a group |
| pi group disable | Disable a group |
| pi group edit | Edit a group |
| pi group enable | Enable a group |
| pi group list | List groups |
| pi group obliterate | Obliterate a group |
| pi ip rm-from-filelist | Edit the release file list to remove obliterated files |
| pi lic load | Load a new license file |
| pi lic usage | Show current license usage |
| pi user | Manage Perforce IPLM users |
| pi user add | Add a user |
| pi user disable | Disable a user |
| pi user edit | Edit a user |
| pi user enable | Enable a user |
| pi user obliterate | Obliterate a user |
| pi user sync | Synchronize a user |
| pi-admin picache | IPLM Cache management functions |
| pi-admin picache remove | Remove an IPV from the cache |
| pi-admin settings edit | Edit the administration settings |
| pi-admin settings list | List the administration settings and their values |
Commands restricted to 'admin' group
| Command | Definition |
|---|---|
| pi alias delete | Remove an alias from an IPV |
| pi alias lock | Lock an alias on an IPV |
| pi alias move | Move a unique alias to a new line/version |
| pi alias unlock | Unlock an alias on an IPV |
| pi dmtype | Manage available IP dm types |
| pi dmtype add | Add a new DM |
| pi dmtype delete | Delete an existing DM |
| pi dmtype edit | Edit an existing DM |
| pi dmtype list | List existing DMs |
| pi group | Manage Perforce IPLM groups |
| pi group add | Add a group |
| pi group disable | Disable a group |
| pi group edit | Edit a group |
| pi group enable | Enable a group |
| pi group list | List groups |
| pi group obliterate | Obliterate a group |
| pi ip obliterate | |
| pi-admin global configuration | |
| pi ip rm-from-filelist | Edit the release file list to remove obliterated files |
| pi label | Manage Library/IP labels |
| pi library add | Create new lib (admin only) |
| pi license load | Load a new license file |
| pi license usage | Show current license usage |
| pi perm add | Add permissions to object(s), keep existing |
| pi perm delete | Remove permissions from object(s) |
| pi perm set | Set permissions on object, remove existing |
| pi property add | Create a new property |
| pi property delete | Delete an existing property |
| pi property edit | Edit an existing property |
| pi property-set add | Create a new property set |
| pi property-set delete | Delete an existing property set |
| pi property-set detach | Detach an existing property set |
| pi property-set edit | Edit an existing property set |
| pi query add | Create a new Saved query |
| pi query attribute | Add an attribute to a Saved query |
| pi query delete | Delete a Saved query |
| pi query edit | Edit a Saved query |
| pi user | Manage Perforce IPLM users |
| pi user add | Add a user |
| pi user disable | Disable a user |
| pi user edit | Edit a user |
| pi user enable | Enable a user |
| pi user obliterate | Obliterate a user |
| pi user sync | Synchronize a user |
| pi-admin picache | IPLM Cache management functions |
| pi-admin picache remove | Remove an IPV from the cache |
| pi-admin settings edit | Edit the administration settings |
| pi-admin settings list | List the administration settings and their values |