Documentation

Support

Unity Version Control

GETWORKSPACEFROMPATH

Get workspace from path with the Unity Version Control CLI.
Read time 1 minuteLast updated 21 days ago

Description

Gets workspace info from a path.

Usage

cm getworkspacefrompath | gwp <item_path> [--format=<str_format>] [--extended]

Options

Option / Argument

Description

--format
Retrieves the output message in a specific format. See Remarks for more info.
--extended
Displays more information regarding the workspace:
type
and
dynamic
on top of the others. See Remarks for more info.
item_path
File or folder on disk.

Help

Remarks

This command shows information about the workspace that is located in path. 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} | {wkname}
Workspace name.
{1} | {wkpath}
Workspace path.
{2} | {machine}
Client machine name.
{3} | {owner}
Workspace owner.
{4} | {guid}
Workspace GUID.
{5} | {type}
Workspace type: partial (gluon) or regular.
{6} | {dynamic}
A workspace can be dynamic (plasticfs) or static.
{tab}
Inserts a tab space.
{newline}
Inserts a new line.

Examples

cm getworkspacefrompath c:\myworkspace\code\file1.cpp --format="Workspace name: {wkname}"
cm gwp . --format="Name: {wkname} | Type: {type}, {dynamic}"