Skip to main content

list

CLI reference

Description

List all projects and their associated directories (path and repository name pairs from the workspace manifest).

Usage

esysrepo list [options ...]

Options

Available options:

  • --fullpath: Display the full work-tree path instead of the relative path (short form -f on this command; prefer the long form when combining with common --folder)
  • --name-only / -n: Display only the repository name
  • --path-only / -p: Display only the path
  • --json / -j: Print versioned JSON (schema esysrepo.list) on stdout
  • --json=<path>: Write that JSON to a file instead of stdout
  • --folder PATH: Workspace folder (common option; default is the current directory)

Examples

On an ESysRepo development workspace:

ESysRepo 0.1.0

[info] List ...
[info] path : name
. : esysbuild/dev
src/esysbuild : esysbuild/esysbuild
src/esysrepo : esysrepo/esysrepo
[info] List done.

JSON on stdout:

esysrepo list --json

Details

The list command can also emit machine-readable JSON:

{
  "meta": {
    "schema": "esysrepo.list",
    "schema_version": 1
  },
  "workspace_root": ".",
  "projects": [
    { "path": "src/foo", "name": "foo" },
    { "path": "src/bar", "name": "bar" }
  ]
}