Command Reference

Browse PDMShell commands by category, or type in the filter box. The alias column shows the short name you can type instead of the full command. Tier shows whether a command needs PDMShell Premium.

Since is 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
showcard	PDMShell 4.0.35	Improved the data card window resize behavior and command output messages for card progress, edits, and saves.
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	Alias	What it does	Tier	Since
login		Log in to PDM	Free	2.0.0
cd		Change directory	Free	2.0.0
dir		List directory contents	Free	2.0.0
mkdir		Create a new PDM directory	Free	2.0.0
clearcache	clsc	Clear cache	Free	2.0.0
refresh		Refresh file metadata and state	Free	4.0.51
history		View complete file history	Free	2.0.0
inbox		Open PDM Inbox	Free	2.0.0
addtovault		Add files to vault	Free	2.0.0
users		List users	—	2.0.0

File Operations

Command	Alias	What it does	Tier	Since
get		Get latest or selected version	Free	2.0.0
checkout	co	Check out	Free	2.0.0
checkin	ci	Check in	Free	2.0.0
undocheckout	udc	Undo checkout	Free	2.0.0
copy		Copy files	Free	2.0.74
copytree		Copy tree	Free	2.0.46
pasteasreference		Paste as custom reference	Free	4.0.0
pasteasshared		Paste as shared file	Free	4.0.9
packandgo		Pack and Go	Free	3.0.27
move		Move files	Free	3.0.28
rename		Rename files	Free	2.0.0
delete	del	Delete files or folders	Free	2.0.0
destroy	dest	Destroy deleted files	Free	2.0.5
recover		Recover deleted files	Free	2.0.74
listreferences		List references	Free	3.0.70
updatereferences		Update references	Free	3.0.23
transition	tr	Change workflow state	Free	2.0.0

Variables

Command	Alias	What it does	Tier	Since
getvar		Get variable value	Free	2.0.0
getvarfromdb	getvardb	Get variable value from database	Free	2.0.0
setvar		Set variable value	Free	2.0.0
setglobal		Set or replace a session global variable	Free	4.0.7
getglobal		Print one or all session global variables	Free	4.0.7
clearglobal		Remove a session global variable	Free	4.0.7
infovar		Get variable information	Free	2.0.0
mkvar		Create a new PDM variable	Free	2.0.0
editvars		Launch Variable Editor	Free	2.0.0
showcard		Open a file or folder data card	Free	4.0.34

Source / CSV

Command	Alias	What it does	Tier	Since
deletefromsource		Delete files from CSV	Free	2.0.2
movefromsource		Move files from CSV	Free	3.0.28
printfromsource		Print information from CSV	Free	2.0.0
renamefromsource	renameource	Rename files from CSV	Free	2.0.2
searchfromsource		Search from CSV	Free	2.0.0
setrevisionfromsource		Set revision from CSV	Free	3.0.12
setvarsfromsource	setvarsource	Set variables from CSV	Free	2.0.1
versionupgradefromsource		Upgrade version from CSV	Free	3.0.13
createvirtualfromsource		Create virtual documents from CSV	Free	2.0.34

Automation

Command	Alias	What it does	Tier	Since
runscript		Run a PDMShell script	Free	2.0.1
runswmacro		Run a SOLIDWORKS macro	Free	2.0.83
runtask		Run a PDM task	Free	2.0.33
runtemplate		Run a PDM template	Free	4.0.0
wait		Wait for seconds	Free	4.0.4
until		Wait until conditions	Free	4.0.7
rebuild		Reserved command. Not implemented yet.	Premium	—
toolbox		Process Toolbox flag	Free	2.0.17
addaddin		Add add-in	—	2.0.0
kill		Stop process	Free	2.0.0

Revision / Version

Command	Alias	What it does	Tier	Since
version	ver	Show version information	Free	2.0.0
rollback		Roll back a checked-in file to an earlier version	Premium	4.0.51
setrevision		Set revision	Free	3.0.11
versionupgrade		Upgrade version after PDM upgrade	Free	3.0.13
frogleap		Frog leap file version	Free	2.0.0

Document Manager

Command	Alias	What it does	Tier	Since
docman		Document Manager operations	Free	2.0.16
docmanprops		Read CAD properties	Free	3.0.30

Utilities

Command	Alias	What it does	Tier	Since
help		List all commands	Free	2.0.0
cls		Clear screen	Free	2.0.0
dump	dmp	Save session output to a file	Free	2.0.0
export		Export files	Free	2.0.0
bom		Export bill of materials	Free	2.0.0
preview		Preview files	—	2.0.0
print	prt	Print file information	Free	2.0.0
fileinfo		Inspect one exact vault file, including checkout and cache status	Free
search		Search for files	Free	2.0.5
msgbox		Show message box	Free	4.0.8
start		Start a process	Free	2.0.0
quit		Quit PDMShell	Free	2.0.0
reboot		Restart PDMShell	Free	2.0.1
whereused		Find parents	Free	2.0.0
whereusedtree		Find recursive parents	Free	4.0.1