Skip to content

Project Describe#

Command: project describe

Shorthands: p d

The project describe command is used to display detailed information about a specified Project structure. This includes information such as the project details, path, package and any associated projects.

Usage#

pars project describe [name] [flags]

Arguments#

Name Datatype Required Default Description
name project true "" Project name

name#

  • Datatype: project
  • Type: text
  • Multiplicity: Required
  • Default: none
  • Validation Rules: Existing project names
  • Args Index: 0
  • Description: Project name

Usage

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

Notes

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

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

Example 

pars project describe LogServiceProject

- LogServiceProject (none-set)
         Labels: []
         Platform: Dotnet
         Type: Web Api
         Runtime: Unknown
         Layers: []

Flags#

📌 See Global flags and Common flags

Name Datatype Required Default Description
--workspace, -w workspace false current_workspace Name of the workspace where the project is located

--workspace#

  • Aliases -w
  • Datatype: workspace
  • Type: text
  • Multiplicity: Optional
  • Default: current_workspace
  • Validation Rules: Existing workspace names
  • Description: Describe project in the specified workspace

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

Usage

The --workspace flag is used to specify the workspace from which you want to describe project. This flag helps you focus on the projects within a particular workspace.

Notes

  • The --workspace flag is used in commands where you need to describe project within a specific workspace.
  • Ensure that the workspace name provided is valid and recognized by Pars to avoid errors during the describing process.
  • This flag is beneficial for scenarios where you need to review or manage projects within a particular workspace.
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 

pars project describe --workspace MyWorkspace LogServiceProject

- LogServiceProject (none-set)
         Labels: []
         Platform: Dotnet
         Type: Web Api
         Runtime: Unknown
         Layers: []