Table of Contents

Command Reference

Use this page to browse PDMShell commands by category. Availability is listed at the bottom of each command page and summarized here for quick scanning.

Availability means the PDMShell version where the command first became available. Last updated means the most recent PDMShell version where the command behavior, parameters, or important command documentation changed.

Recently Updated Commands

Command Last Updated What Changed
search PDMShell 4.0.14 Added result shaping with SortBy, SortOrder, GroupBy, DuplicatedBy, and Strategy for commands that use -search.
msgbox PDMShell 4.0.14 Added session-level placeholder evaluation for value and title, including $vaultName, $date, $time, $guid, and $tempFolder.

Vault

Command Description Availability
login Log in to PDM Available since PDMShell 2.0.0.
cd Change directory Available since PDMShell 2.0.0.
dir List directory contents Available since PDMShell 2.0.0.
mkdir Create a new PDM directory Available since PDMShell 2.0.0.
clearcache Clear cache Available since PDMShell 2.0.0.
history View complete file history Available since PDMShell 2.0.0.
inbox Open PDM Inbox Available since PDMShell 2.0.0.
addtovault Add files to vault Available since PDMShell 2.0.0.
users List users Available since PDMShell 2.0.0.

File Operations

Command Description Availability
get Get latest or selected version Available since PDMShell 2.0.0.
checkout Check out Available since PDMShell 2.0.0.
checkin Check in Available since PDMShell 2.0.0.
undocheckout Undo checkout Available since PDMShell 2.0.0.
copy Copy files Available since PDMShell 2.0.74.
copytree Copy tree Available since PDMShell 2.0.46.
pasteasreference Paste as custom reference Available since PDMShell 4.0.0.
pasteasshared Paste as shared file Available since PDMShell 4.0.9.
packandgo Pack and Go Available since PDMShell 3.0.27.
move Move files Available since PDMShell 3.0.28.
rename Rename files Available since PDMShell 2.0.0.
delete Delete files or folders Available since PDMShell 2.0.0.
destory Destroy deleted files Available since PDMShell 2.0.5.
recover Recover deleted files Available since PDMShell 2.0.74.
listreferences List references Available since PDMShell 3.0.70.
updatereferences Update references Available since PDMShell 3.0.23.
transition Change workflow state Available since PDMShell 2.0.0.

Variables

Command Description Availability
getvar Get variable value Available since PDMShell 2.0.0.
getvarfromdb Get variable value from database Available since PDMShell 2.0.0.
setvar Set variable value Available since PDMShell 2.0.0.
globalvariables Global variables Available since PDMShell 4.0.7.
infovar Get variable information Available since PDMShell 2.0.0.
mkvar Create a new PDM variable Available since PDMShell 2.0.0.
editvars Launch Variable Editor Available since PDMShell 2.0.0.

Source / CSV

Command Description Availability
deletefromsource Delete files from CSV Available since PDMShell 2.0.2.
movefromsource Move files from CSV Available since PDMShell 3.0.28.
printfromsource Print information from CSV Available since PDMShell 2.0.0.
renamefromsource Rename files from CSV Available since PDMShell 2.0.2.
searchfromsource Search from CSV Available since PDMShell 2.0.0.
setrevisionfromsource Set revision from CSV Available since PDMShell 3.0.12.
setvarsfromsource Set variables from CSV Available since PDMShell 2.0.1.
versionupgradefromsource Upgrade version from CSV Available since PDMShell 3.0.13.
createvirtualfromsource Create virtual documents from CSV Available since PDMShell 2.0.34.

Automation

Command Description Availability
runscript Run a PDMShell script Available since PDMShell 2.0.1.
runswmacro Run a SOLIDWORKS macro Available since PDMShell 2.0.83.
runtask Run a PDM task Available since PDMShell 2.0.33.
runtemplate Run a PDM template Available since PDMShell 4.0.0.
wait Wait for seconds Available since PDMShell 4.0.4.
until Wait until conditions Available since PDMShell 4.0.7.
rebuild Ghost rebuild SOLIDWORKS files Available since PDMShell 2.0.0.
toolbox Process Toolbox flag Available since PDMShell 2.0.17.
addaddin Add add-in Available since PDMShell 2.0.0.
kill Stop process Available since PDMShell 2.0.0.

Revision / Version

Command Description Availability
version Show version information Available since PDMShell 2.0.0.
setrevision Set revision Available since PDMShell 3.0.11.
versionupgrade Upgrade version after PDM upgrade Available since PDMShell 3.0.13.
frogleap Frog leap file version Available since PDMShell 2.0.0.

Document Manager

Command Description Availability
docman Document Manager operations Available since PDMShell 2.0.16.
docmanprops Read CAD properties Available since PDMShell 3.0.30.

Utilities

Command Description Availability
help List all commands Available since PDMShell 2.0.0.
cls Clear screen Available since PDMShell 2.0.0.
dump Save session output to a file Available since PDMShell 2.0.0.
export Export files Available since PDMShell 2.0.0.
bom Export bill of materials Available since PDMShell 2.0.0.
preview Preview files Available since PDMShell 2.0.0.
print Print file information Available since PDMShell 2.0.0.
search Search for files Available since PDMShell 2.0.5.
msgbox Show message box Available since PDMShell 4.0.8.
start Start a process Available since PDMShell 2.0.0.
quit Quit PDMShell Available since PDMShell 2.0.0.
reboot Restart PDMShell Available since PDMShell 2.0.1.
whereused Find parents Available since PDMShell 2.0.0.
whereusedtree Find recursive parents Available since PDMShell 4.0.1.
Edit this page