WORKSPACE LIST
Description
Lists workspaces.
Usage
cm workspace | wk [list | ls] [--format=<str_format>]
Options
| Option / Argument | Description |
|---|---|
| --format | Retrieves the output message in a specific format. See Remarks for more info. |
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} | {wkname} | Workspace name. |
| {1} | {machine} | Client machine name. |
| {2} | {path} | Workspace path. |
| {3} | {wkid} | Workspace unique identifier. |
| {4} | {wkspec} | Workspace specification using the format: 'wkname@machine'. |
| {tab} | Inserts a tab space. |
| {newline} | Inserts a new line. |
Examples
cm wk
(Lists all workspaces.)
cm workspace list --format={0}#{3,40}
cm workspace list --format={wkname}#{wkid,40}
(Lists all workspaces and shows the workspace name, a # symbol and the workspace GUID field in 40 spaces, aligned to left.)
cm wk --format="Workspace {0} in path {2}"
cm wk --format="Workspace {wkname} in path {path}"
(Lists all workspaces and shows result as formatted strings.)