Unity Version Control CLI
Overview of the version control CLI in Unity Version Control.
Read time 2 minutesLast updated 10 months ago
Unity Version Control CLI, or 'cm', is a command line interface for use in your terminal or your scripts.
This reference includes all available commands documentation with usage guides and examples.
Installation
To install the Unity Version Control CLI, follow these steps:
- Go to the download page.
- Click the corresponding Download button:
- Cloud Edition if you are using it in the cloud.
- Enterprise Edition if you are using it on-premises.
- The download will start.
- Follow the installer instructions and complete the installation.
Getting Started
After installing the CLI, you can complete its configuration by opening a terminal and following the configure documentation, or you can use the Desktop Client wizard.
To proceed with the Desktop Client wizard, you can open the Unity Version Control shortcut from your application explorer. Alternatively, you can open your terminal and enter the following command to launch it:
Windows Users
plastic --configure
Mac or Linux Users
plasticgui --configure
cm
Now that everything is configured, you can start using the CLI. To access it through your terminal, type:
cm <command>
Replace with any of the available commands.
<command>Note
At any moment you can access the documentation from the CLI by using or typing .
cm helpcm <command> --helpExamples
cm repository list
cm help
cm showcommands
Available Commands
- acl
- activateuser
- add
- admin
- annotate
- api
- applylocal
- archive
- attribute
- autocomplete
- branch
- changelist
- changerevisiontype
- changeset
- changeuserpassword
- checkconnection
- checkin
- checkout
- checkselectorsyntax
- clone
- codereview
- configureclient
- crypt
- deactivateuser
- diff
- diffmetrics
- fastexport
- fastimport
- fileinfo
- find
- getconfig
- getfile
- getrevision
- getstatus
- gettaskbranches
- getworkspacefrompath
- getworkspaceinfo
- help
- history
- iostats
- issuetracker
- label
- licenseinfo
- linktask
- list
- listusers
- location
- lock
- log
- merge
- move
- objectspec
- partial
- patch
- profile
- pull
- purge
- push
- query
- remove
- repository
- revert
- setowner
- shelveset
- show-find-objects
- showacl
- showcommands
- showowner
- showpermissions
- support
- switch
- sync
- trigger
- tube
- undelete
- undo
- undochange
- undocheckout
- undocheckoutunchanged
- update
- version
- whoami
- workspace
- workspacestatus
- xlink