ADD
Add items with the Unity Version Control CLI.
Read time 2 minutesLast updated 10 months ago
Description
Adds an item to version control.
Usage
cm add [-R | -r | --recursive] [--silent] [--ignorefailed] [--skipcontentcheck] [--coparent] [--filetypes=<file>] [--noinfo] [--format=<str-format>] [--errorformat=<str-format>] <item-path>[ ...]
Options
Option / Argument | Description |
|---|---|
| -R | -r | --recursive | Adds items recursively. |
| --silent | Does not show any output. |
| --ignorefailed | If an item cannot be added, the add operation will continue without it. Note: If a directory cannot be added, its content is not added. |
| --skipcontentcheck | When the extension is not enough to set the file as text or binary, it will be set as binary instead of checking the content to detect the type. This is done to increase performance on huge checkins. |
| --coparent | Runs a checkout of the parent of the item being added. |
| --filetypes | The filetypes file to use. |
| --noinfo | Doesn't print progress information. |
| --format | Retrieves the output message in a specific format. Check the examples for more information. |
| --errorformat | Retrieves the error message (if any) in a specific format. Check the examples for more information. |
| item-path | The item or items to add. Use double quotes (" ") to specify paths containing spaces. Use a whitespace to separate items. Use * to add all the contents of the current directory. |
Help
Remarks
Requirements to add items
- The parent directory of the item to add must have been previously added.
Reading input from stdin
The 'add' command can read paths from stdin. To do this, pass a single dash "-". Example:
cm add -
Paths will be read until an empty line is entered. This allows you to use pipe to specify which files to add. Example:
dir /S /B *.c | cm add -(In Windows, adds all .c files in the workspace.)
Examples
cm add file1.txt file2.txt
(Adds 'file1.txt' and 'file2.txt' items.)
cm add c:\workspace\file.txt
(Adds 'file.txt' item in path 'c:\workspace'.)
cm add -R c:\workspace\src
(Recursively adds 'src'.)
cm add -R *
(Recursively adds all the contents of the current directory.)
cm add -R * --filetypes=filetypes.conf
(Recursively adds all the contents of the current directory, using 'filetypes.conf' to assign a type to each file based on its extension, instead of checking its content.)
cm add --coparent c:\workspace\dir\file.txt
(Adds 'file.txt' to source control, and performs a checkout of 'dir'.)
cm add -R * --format="ADD {0}" --errorformat="ERR {0}"
(Recursively adds all the contents of the current directory, printing 'ADD <item />' for successfully added files, and 'ERR <item>' for items that could not be added.)