Skip to content

Commands#

The pars command is the root command for managing workspaces, groups, and other tasks. It supports various subcommands and global flags to provide flexibility and control over different environments and logging levels.

Usage#

pars [type] [command] [options] [flags]
Tip

Aliases are shorthands for commands and flags in example, workspace remove shorthand is w r

Commands#

Name Description
init Creates a new workspace
workspace Manages workspaces, including list, describe, and remove
group Manages groups
completion Provides autocompletion support for the CLI

init#

The init command is used to create a new workspace. This is the only way to create a workspace in the application.

workspace#

The workspace command is used to manage workspaces. It supports subcommands like list, describe, and remove.

group#

The group command is used to manage groups. It supports subcommands like list, new, describe, and remove.

completion#

The completion command provides autocompletion support for the CLI.

Tip

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

Global Flags#

Name Datatype Required Default Description
env, e string false workspace Provides full isolation for tasks and processes, operating within the specified environment.
log-level LogLevelEnum false Error Sets the logging level to control the verbosity of log output (e.g., debug, info).

env#

  • Aliases e
  • Datatype: string
  • Type: text
  • Multiplicity: Optional
  • Default: none
  • Description: Provides full isolation for tasks and processes. Only operates within the specified Environment when the flag is set.
Example

Specific environment : workspace list in specific environment

pars workspace list --env my-env
(0) workspace available

Running on 'my-env' environment

log-level#

  • Datatype: LogLevelEnum
  • Type: enum
  • Multiplicity: Optional
  • Default: Error
  • Valid Values: Silence, Verbose, Info, Warn, Error, Fatal
  • Description: Sets the logging level to control the verbosity of log output. Useful for debugging and monitoring.
Example

Set logging level : workspace list with verbose logging

pars workspace list --log-level verbose
(0) workspace available

Common Flags#

Name Datatype Required Default Description
help, h none false "" Displays usage information and summaries for commands.

help#

  • Aliases h
  • Datatype: none
  • Type: none
  • Multiplicity: Optional | Single
  • Default: none
  • Description: Displays usage information and summaries for commands.
Example

Print help details for command : See workspace list help details

pars workspace list --help

List workspace project(s)


Usage:
  pars workspace list [flags]


Aliases:
  list, l


Examples:
  pars workspace list [flags]
  pars wl [flags]


Flags:
  -h, --help   help for list


Global Flags:
      --config string        config file (default is $HOME/.cli.yaml)
  -e, --env string           Environment (dev, prod, test, ...)
      --log-level LogLevel   Select log level [Silence Verbose Info Warn Error Fatal] (default Error)

This documentation provides a comprehensive overview of the pars root command, its subcommands, and global flags. Utilize these commands and flags to effectively manage workspaces, groups, and other related tasks within the CLI application.