Skip to content

Workspace Describe#

Command: workspace describe

Shorthands: w d

The workspace describe command is used to display detailed information about a specified Workspace. This includes information such as the workspace's path, associated projects, and their structure. The command supports additional flags to customize the output.

Usage#

pars workspace describe [name] [flags]
Example 

pars workspace describe OmicronConsulting

Workspace (OmicronConsulting) has 2 project
Path : C:\current_directory\OmicronConsulting


Projects:
ApexSolutions
- UserAuthService ()
- PaymentGatewayService ()

Arguments#

Name Datatype Required Default Description
name workspace false current_workspace The name of the workspace you want to describe

name#

  • Datatype: workspace
  • Type: text
  • Multiplicity: Optional
  • Default: current_workspace
  • Validation Rules: Existing workspace names
  • Args Index: 0
  • Description: Workspace name

💡 If you don't specify workspace name, by default pars get current workspace details

Usage

The name argument is used to specify the workspace name that you want to describe. This is required for the command to execute.

Notes

  • Ensure the workspace name provided is valid and exists to avoid errors during command execution.
Tip

You can use suggestions to list available workspaces. To do this, simply press Tab to proceed. For more details, please visit our Workspace Autocompletion and Filtering Guide.

Example

Current workspace : Get details for current workspace

pars workspace describe

Workspace (OmicronConsulting) has 2 project
Path : C:\current_directory\OmicronConsulting


Projects:
ApexSolutions
- UserAuthService ()
- PaymentGatewayService ()

Specific workspace : Get details for custom workspace

pars workspace describe EpsilonEnterprises

Workspace (EpsilonEnterprises) has 0 project
Path : C:\current_directory\EpsilonEnterprises


Projects:
ApexSolutions
- UserAuthService ()
- PaymentGatewayService ()

Flags#

📌 See Global flags and Common flags

Name Datatype Required Default Description
--path, -p boolean false false Show only the path of the workspace
--view, -v WorkspaceViewTypesEnum false Hierarchical Specify the view format (e.g., hierarchical, flat)

--path#

  • Aliases -p
  • Datatype: boolean
  • Type: boolean
  • Multiplicity: Optional
  • Default: false
  • Description: Show only the path of the workspace.
Use Cases
  • Change working directory

cd (pars workspace describe --path)


pars workspace describe --path | cd

  • Open working directory in VS Code

code (pars workspace describe --path)


pars workspace describe --path | code

Usage

The --path flag is used to display only the path of the specified workspace. No additional information will be shown.

Notes

  • This flag does not require a value; simply setting the flag will trigger this behavior.
Example 

pars workspace OmicronConsulting --path
C:\foo\current_directory\OmicronConsulting

‼ path flag should be used alone, if you set this flag, you will get only path

pars workspace describe --path --view flat
C:\foo\current_directory\OmicronConsulting

--view#

  • Datatype: WorkspaceViewTypesEnum
  • Type: enum
  • Multiplicity: Optional
  • Default: Hierarchical
  • Valid Values: Hierarchical, Flat
  • Description: Specify the view format for the projects within the workspace
Tip

You can use suggestions to list available view types. To do this, simply press Tab to proceed. For more details, please visit our Enumeration Autocompletion and Filtering Guide.

Usage

The --view flag is used to specify how the projects within the workspace should be displayed. The default format is flat, but it can be set to hierarchical to show a nested structure.

Notes

  • Ensure the specified format is supported to avoid errors during command execution.
Example

Hierarchical View : List workspace projects in tree view

pars workspace describe --view Hierarchical

Workspace (OmicronConsulting) has 2 project
Path : C:\current_directory\OmicronConsulting


Projects:
ApexSolutions
- UserAuthService ()
- PaymentGatewayService ()

Flat View : List workspace projects in basic list

pars workspace describe --view Flat

Workspace (OmicronConsulting) has 2 project
Path : C:\current_directory\OmicronConsulting


Projects:
ApexSolutions
- UserAuthService ()
- PaymentGatewayService ()