SHELVESET CREATE
Create shelvesets with the Unity Version Control CLI.
Read time 2 minutesLast updated 10 months ago
Description
Shelves pending changes.
Usage
cm shelveset create | mk [<item_path>[ ...]] [--all] [--dependencies] [-c=<str_comment> | -commentsfile=<comments_file>] [--summaryformat]
Options
Option / Argument | Description |
|---|---|
| item_path | Items to shelve. Use a whitespace to separate user names. Use double quotes (" ") to specify paths containing spaces. |
| --all | The items changed, moved, and deleted locally, on the given paths, will also be included. |
| --dependencies | Includes local change dependencies into the items to shelve. |
| --summaryformat | Just prints the shelveset spec created for the main repo, skipping shelvesets of xlinked repos and any other output messages. For automation purposes. |
| -c | Applies the specified comment to the created shelve. |
| -commentsfile | Applies the comment in the specified file to the created shelve. |
Help
The 'shelveset create' command stores the contents of checked out items inside the
repository. This way the contents are protected without the need to checkin the files.
Remarks
If neither <item_path> nor any option is specified, the shelveset will include all the pending changes in the workspace.
The 'shelveset create' operation is always applied recursively from the given path.
Requirements to shelve an item
- The item must be under source code control.
- The item must be checked out or changed ('--all' option must be used).
Set the PLASTICEDITOR environment variable to specify an editor for entering comments. If the PLASTICEDITOR environment variable is set, and the comment is empty, the editor will be automatically launched to allow you to specify the comment.
Examples
cm shelveset create -c="my comment"
(Shelves all the pending changes in the current workspace including a comment.)
cm shelveset file1.txt "file 2.txt" -commentsfile=commentshelve.txt
(Shelves the selected pending changes and applies the comment in the 'commentshelve.txt' file. Note, 'create' is the default subcommand.)
cm status --short --changelist=pending_to_review | cm shelveset -
(Shelves client changelist. The command above lists the paths in the changelist named 'pending_to_review' and the path list is redirected to the input of the 'shelveset' command.)