Skip to content

Group Remove#

Command: group remove

Shorthands: g r

The group remove command is used to delete one or more specified Group structures. Groups can be removed by providing one or more name arguments or using the --file flag to specify a configuration file with the group names to delete.

Usage#

pars group remove name [name] [flags]

pars group remove [flags]

Arguments#

Name Datatype Required Default Description
name []group true "" Group name

name#

  • Datatype: []group
  • Type: text
  • Multiplicity: Multiple
  • Default: none
  • Validation Rules: Existing Group names
  • Args Index: all
  • Description: Names of the groups you want to remove. If provided, the --file flag will be ignored.
Tip

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

Usage

The name argument is used to specify one or more group names that you want to remove. This is useful for quickly deleting a few groups without needing a configuration file.

Notes

  • Multiple group names can be provided as space-separated values.
  • If the name argument is provided, the --file flag will be ignored even if it is specified.
  • Ensure the group names provided are valid and exist to avoid errors during command execution.
Example

Removing single group 

pars group remove ApexSolutions
Group (ApexSolutions) deleted permanently

Removing multiple group 

pars group remove ApexSolutions NeptuneDev

Group (ApexSolutions) deleted permanently
Group (NeptuneDev) deleted permanently

Flags#

📌 See Global flags and Common flags

Name Datatype Required Default Description
--file, -f file true "" Remove group(s) from manifest file

--file#

  • Aliases -f
  • Datatype: file
  • Type: text
  • Schema: GroupObjectHeaderModel
  • Multiplicity: Optional
  • Description: Specify the path to a file containing group names to remove. This will be ignored if any name arguments are provided.
  • Valid Values: current_folder, absoulute_path_to_folder, absoulute_path_to_file, relative_path_to_folder, relative_path_to_file

‼ If the name argument is provided, the command will ignore the --file flag.

Usage

  • The --file flag is used to specify a configuration file containing the names of the groups to be removed. The file should contain a list of group names. This flag is useful for batch deletion of groups.

Notes

  • Ensure that the file path provided with the --file flag is accessible and contains valid group names to avoid errors during command execution.

Supported Path Formats

  • Current Directory (.): Specifies the current working directory from which the command is being executed. This is useful for operations that need to be performed in the current directory without specifying the full path.

  • Relative Directory or File: Specifies a path relative to the current working directory. This allows for flexibility in specifying paths without needing the full directory structure.

  • Absolute Directory or File: Specifies the full path to a directory or file, starting from the root of the filesystem. This is useful when the exact location of the file or directory is known.

Tip

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

Example

Specify Current Directory

pars group remove --file .

Group (ApexSolutions) deleted permanently
Group (NeptuneDev) deleted permanently
Group (OrionTech) deleted permanently

Specify a Relative Directory

pars group remove --file ./samples/

Group (ApexSolutions) deleted permanently
Group (NeptuneDev) deleted permanently
Group (OrionTech) deleted permanently

Specify a Relative File

pars group remove --file ./samples/ApexSolutions.yaml

Group (ApexSolutions) deleted permanently

Specify an Absolute Directory

pars group remove --file C:/samples/

Group (ApexSolutions) deleted permanently
Group (NeptuneDev) deleted permanently
Group (OrionTech) deleted permanently

Specify an Absolute File

pars group remove --file C:/samples/ApexSolutions.yaml

Group (ApexSolutions) deleted permanently

Specify Multiple Files or Directories

pars group remove --file ./samples/ApexSolutions.yaml --file ./samples/NeptuneDev.yaml

Group (ApexSolutions) deleted permanently
Group (NeptuneDev) deleted permanently