Documentation

​
​

Development

User Acquisition

Monetization

Industry

Unity Version Control

DevOps

On-prem

Gluon

Editor plug-in

Open Unity Dashboard

Unity Version Control

​
​
Unity Version Control
  • Overview
  • Cloud Repositories organization update
  • Installation
  • Use UVCS with the Unity Editor
  • Unity Version Control plugins
  • Concepts
  • Tutorials
  • On-Prem
  • Gluon
  • CLI and shortcut references
    • Unity Version Control CLI
      • acl
      • activateuser
      • add
      • admin
      • annotate
      • api
      • applylocal
      • archive
      • attribute
      • autocomplete
      • branch
      • changelist
      • changerevisiontype
      • changeset
      • changeuserpassword
      • checkconnection
      • checkin
      • checkout
      • checkselectorsyntax
      • clone
      • codereview
      • configure
      • crypt
      • deactivateuser
      • diff
      • diffmetrics
      • fastexport
      • fastimport
      • fileinfo
      • find
      • getconfig
      • getfile
      • getrevision
      • getstatus
      • gettaskbranches
      • getworkspacefrompath
      • getworkspaceinfo
      • help
      • history
      • iostats
      • issuetracker
      • label
      • licenseinfo
      • linktask
      • list
      • listusers
      • location
      • lock
      • log
      • merge
      • move
      • objectspec
      • partial
      • patch
      • profile
      • pull
      • purge
      • push
      • query
      • remove
      • repository
      • revert
      • setowner
      • shelveset
      • show-find-objects
      • showacl
      • showcommands
      • showowner
      • showpermissions
      • support
      • switch
      • sync
      • trigger
      • tube
      • undelete
      • undo
      • undochange
      • undocheckout
      • undocheckoutunchanged
      • update
      • version
      • whoami
      • workspace
      • workspacestatus
      • xlink
    • CLI help
    • Pipe commands
    • cm find
    • Windows keyboard shortcuts
  • Release Notes
  1. Unity Version Control (previously Plastic SCM)

GETWORKSPACEFROMPATH

Get workspace from path with the Unity Version Control CLI.
Read time 1 minute
Last updated 10 months 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}"

Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

  • On this page
    • Description

      • Usage

      • Options

    • Help

      • Remarks

        • The output parameters of this command are the following

      • Examples


Report a problem with this page