Skip to main content

workspace

workspace - Display projects information for the workspace

Description​

Display targets information within a project.By default, the results will be printed in a table with information such as :

  • The project's name
  • The project's description
  • The project's relative path from the workspace root
  • The project's declared tags

By default, all projects are described.

Synopsis​

workspace [--summary ] [-p / --projects <PROJECTS>] [-s / --selector <SELECTOR>] [-a / --all ] [--include <INCLUDE>...] [--exclude <EXCLUDE>...] [--tags <TAGS>]

Options​

  • [--summary ] : Display each project name, line per line, instead of a full table with details.
  • [-p / --projects <PROJECTS>] : A list of project names. Will be parsed as a comma-separated list of project names (for e.g project1,project2,project3).
  • [-s / --selector <SELECTOR>] : A named selector to use when selecting projects. It must be declared at the workspace level.
  • [-a / --all ] : Select all projects in the workspace.
  • [--include <INCLUDE>...] : A pattern to use for including projects. You can pass this option multiple times if you want to use more than one inclusion pattern. Each pattern must be a valid regular expression. If you want to exclude some projects, you can use the --exclude option.
  • [--exclude <EXCLUDE>...] : A pattern to use for excluding projects that were selected using the --include option. You can pass this option multiple times if you want to use more than one exclusion pattern. Each pattern must a valid regular expression.
  • [--tags <TAGS>] : Tags to use when selecting projects. All projects that have at least one tag corresponding to one of the provided tags will be selected. You can pass multiple tags delimited by commas (for example, tag1,tag2,tag3).

Arguments​

No positional arguments for this command.

Subcommands​

No subcommands for this command.