CLI commands

Administrative

Branch

Changelist

Client configuration

File

Label

Shelf

Other

File commands

Command	Shortcut	Description
add		Add files to Surround SCM
annotate		Annotate a file
breakshare	bs	Break a link between shared files
checkin	ci	Check in files
checkout	co	Check out files
cpfile	cpf	Copy files from one branch to another
diff		Display differences between files
diffreport	dr	Generate a report of differences between text file versions
findinfiles	fif	Search file content using a specific text phrase or regular expression
get		Retrieve a read-only copy of files or a repository to a local directory
history		Display the history of files or a repository
ignoretest	it	Test if a specified item is ignored by ignore rules specified in the .sscmignoruser or .sscmignore files.
ls		Display all files and repositories in a repository
merge		View file differences and merge changes into one file
mkrepository	mkrepo mr	Add a repository
move		Move files or a repository
promotefile	pf	Promote file or repository changes
property		Set and display file or repository properties
rebasefile	rf	Rebase file or repository changes
rename		Rename a file or repository
restore		Restore a removed file or repository
rm		Remove a file or repository
rollback	rbk	Roll back a file to a previous version
setcustomfield	scf	Set a custom field value on a file
setstate	ss	Set the workflow state on files
share		Link files
uncheckout	uco	Cancel a check out and discard changes to files in the working directory
voidcheckout	vco	Undo the check out of files or a repository

Branch commands

Command	Shortcut	Description
branchdiff	bd	Display differences between two branches
branchhistory	bh	Display branch history
branchproperty	bp	Set and display branch security
changebranchattrib	cba	Set and display branch attributes
changebranchtype	cbt	Change a workspace branch type
duplicatechanges	dc	Duplicate changes made to files from one branch to another branch
lsbranch	lb	Display all branches in a repository
lsmainline	lml	Display a list of all mainline branches
mkbranch	mb	Add a branch
promote		Promote branch changes
rebase		Rebase branch changes
renamebranch		Rename a branch
restorebranch		Restore a removed branch
rmbranch	rb	Remove a branch

Shelf commands

Command	Shortcut	Description
addshelf	as	Add a shelf
lsshelf		Display a list of shelves
rmshelf		Remove a shelf
shelf		Add files to a shelf
unshelf		Get files from a shelf

Changelist commands

Command	Shortcut	Description
commitchangelist	ccl	Commit a pending changelist
editchangelist	ecl	Edit a pending changelist
lschangelist	lcl	Display pending and committed changelists

Label commands

Command	Shortcut	Description
addlabel	albl	Add a label
editlabel	elbl	Edit a label
label		Label files or a repository
labeledfilesreport	lfr	Generate a report of files with labels
lslabel	llbl	Display a list of labels
rmlabel	rmlbl	Delete a label
unlabel	unl	Remove a label from files or a repository

Client configuration commands

Command	Shortcut	Description
cloak	ck	Cloak a repository to skip it when performing a recursive get, check in, check out, or undo check out
lscloak	lck	Display cloaked repositories
rmworkdir	rmwd	Remove a working directory
setclient	sc	Set and display client options
showworkdirs	swd	Display a list of the working directories on a computer
uncloak	uck	Uncloak a repository
workdir	wd	Set the working directory
workdirinfo	wdi	Display branch and repository information for a working directory

Administrative commands

Command	Shortcut	Description
Custom fields
addcustomfield	acf	Add a custom field
editcustomfield	ecf	Edit a custom field
lscustomfield	lcf	Display all custom fields or a specific custom field
rmcustomfield	rcf	Remove a custom field or restore a deleted custom field
Database and server management
analyzedb	adb	Analyze a Surround SCM database for issues
dblock	dbl	Lock the Surround SCM Server database
editmailqueue	emq	Resend or delete pending messages in the mail queue
lsmailqueue	lmq	Display pending messages in the mail queue
lsserverlog	lsl	Display the server log
rmserverlog	rsl	Delete the server log
servercacheoption	sco	Set and display server caching options
servercheckforupdate	scfu	Display product update information
servercomplianceoption	scoo	Set and display server compliance options
serveremailoption	seo	Set server email options
serverlogoption	slo	Set and display server logging options
serveroption	so	Set and display server options
serverrdbmsoption	sro	Set and display RDBMS connection options
serverunicodeoption	suo	Set and display server Unicode options
serverupdatecheckoption	suco	Set and display options to check for product updates
Mainline branches
addexistingmainline	aeml	Restore a mainline branch and make it active again
exportrepository	er	Export a repository from a mainline branch to copy it to a new or existing mainline
mainlinecomplianceoption	mcoo	Set and display compliance options for a mainline branch
mainlineoption	mo	Set and display options for a mainline branch
mainlineunicodeoption	muo	Set and display Unicode options for automatically merging text files on mainline branches
mkmainline	mml	Add a mainline branch
rmmainline	rml	Remove a mainline branch
upgrademainline	uml	Upgrade an existing mainline branch to the current database format
Proxy server
addproxy	ap	Add a proxy server
editproxy	ep	Edit proxy server settings
lsproxy	lp	Display proxy server information
rmproxy	rp	Delete a proxy server
Security and users
addgroup	ag	Add a security group
adduser	au	Add a Surround SCM user
editgroup	eg	Edit a security group
edituser	eu	Edit user information
lsgroup	lg	Display security group information
lsuser	lu	Display user information
renamegroup		Rename a security group
retrieveuser	rtu	Retrieve a global user from the Helix ALM License Server
rmgroup	rg	Remove a security group
rmuser	ru	Delete a user
securerepository	sr	Set and display repository security
Shadow folders
editshadow	es	Edit or update a shadow folder
lsshadow	lss	Display a list of shadow folders
mkshadow	mks	Create a shadow folder
rmshadow	rms	Remove a shadow folder
Helix ALM and issue tracking integration Note:  TestTrack was renamed Helix ALM starting with the 2017.1 release.
fetchttdb	ftt	Display a list of projects stored on a Helix ALM Server
lsissue	ld	Display issues assigned to a Helix ALM user
lsissuefilter	ldf	Display Helix ALM issue filters
lsttdb	ltt	Display a list of Helix ALM project connections
rmttdb	rtt	Delete a Helix ALM project connection
setttdb	stt	Add or edit a Helix ALM project connection

Other commands

Command	Shortcut	Description
addcodereview	acr	Add a code review
batch		Process Surround SCM commands from an input file
bulkcustomfieldchange	bcfc	Set custom field values for multiple files
cruisecontrol	cc	Display formatted history information that CruiseControl can parse
lscodereview	lcr	Display all unapproved or approved code reviews
lsfilter	lf	Display Surround SCM filters
lsreport	lr	Display a list of all saved reports
lsstate	lst	Display a list of all workflow states
passwd	pw	Change your password
runreport	rr	Run a report
version		Display the Surround SCM Server and CLI versions