GETSTATUS
Get status information with the Unity Version Control CLI.
Read time 1 minuteLast updated 21 days ago
Description
Gets the status of an item.
Usage
cm getstatus | gs <item_path>[ ...] [--format=<str_format>] [--stats] [-R | -r | --recursive]
Options
Option / Argument | Description |
|---|
| --format | Retrieves the output message in a specific format. See Remarks for more info. |
| --stats | Prints some statistics about the get status process. |
| -R | -r | --recursive | Shows recursively the status in directories. |
| item_path | Item or items to get status from. Use double quotes (" ") to specify paths containing spaces. Use a whitespace to separate paths. |
Help
Remarks
Output format parameters (--format option): This command accepts a format string to show the output.
The output parameters of this command are the following
Option / Argument | Description |
|---|
| 0 | Item path. |
| 1 | Item status: |
Where status can take values among the following
Option / Argument | Description |
|---|
| 0 | private |
| 1 | checked in |
| 2 | checked out |
Reading input from stdin
The 'getstatus' command can read paths from stdin. To do this, pass a single dash "-". Example:
Paths will be read until an empty line is entered. This allows you to use pipe to specify which paths to get the status for. Example:
dir /S /B *.c | cm getstatus --format="Path {0} Status {1}" -
Examples
cm getstatus file1.txt file2.txt
(Gets the status of the files.)
cm gs info\ -R --format="The item {0} has the status {1}"
(Gets the status of the directory and all of its items and shows a formatted output.)