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.
Vault
Command
Alias
What it does
Tier
login
Log in to PDM
Free
cd
Change directory
Free
dir
List directory contents
Free
mkdir
Create a new PDM directory
Free
clearcache
clsc
Clear cache
Free
refresh
Refresh file metadata and state
Free
history
View complete file history
Free
inbox
Open PDM Inbox
Free
addtovault
Add files to vault
Free
users
List users
—
File Operations
Variables
Command
Alias
What it does
Tier
getvar
Get variable value
Free
getvarfromdb
getvardb
Get variable value from database
Free
setvar
Set variable value
Free
setglobal
Set or replace a session global variable
Free
getglobal
Print one or all session global variables
Free
clearglobal
Remove a session global variable
Free
infovar
Get variable information
Free
mkvar
Create a new PDM variable
Free
editvars
Launch Variable Editor
Free
showcard
Open a file or folder data card
Free
Source / CSV
Automation
Command
Alias
What it does
Tier
runscript
Run a PDMShell script
Free
runswmacro
Run a SOLIDWORKS macro
Free
runtask
Run a PDM task
Free
runtemplate
Run a PDM template
Free
wait
Wait for seconds
Free
until
Wait until conditions
Free
rebuild
Rebuild and save checked-out SOLIDWORKS files
Premium
toolbox
Process Toolbox flag
Free
addaddin
Add add-in
—
kill
Stop process
Free
Revision / Version
Command
Alias
What it does
Tier
version
ver
Show version information
Free
rollback
Roll back a checked-in file to an earlier version
Premium
setrevision
Set revision
Free
versionupgrade
Upgrade version after PDM upgrade
Free
frogleap
Frog leap file version
Free
Document Manager
Command
Alias
What it does
Tier
docman
Document Manager operations
Free
docmanprops
Read CAD properties
Free
Utilities
Command
Alias
What it does
Tier
help
List all commands
Free
cls
Clear screen
Free
dump
dmp
Save session output to a file
Free
export
Export files
Free
bom
Export bill of materials
Free
preview
prvw
View bitmap/3D previews or export images
Free
browse
Reveal a vault file in Explorer
Free
browsefile
Choose an existing file and store its path
Free
browsefolder
Choose an existing folder and store its path
Free
print
prt
Print file information
Free
fileinfo
Inspect one exact vault file, including checkout and cache status
Free
search
Search for files
Free
msgbox
Show message box
Free
start
Start a process
Free
quit
Quit PDMShell
Free
reboot
Restart PDMShell
Free
whereused
Find parents
Free
whereusedtree
Find recursive parents
Free
ERP
Command
Alias
What it does
Tier
manage
manage
Call SOLIDWORKS Manage API endpoints and select response values (4.1.60+).
Free
odoo
odoo
Synchronize items, mapped properties, thumbnails and BOMs with Odoo.
Free