CLI command

probierz apps list

List every product whose repository under the workspace declares `.probierz/<appId>.yaml`, with its targets and journeys.

Invocation#

Shell
probierz apps list

Required inputs and options#

  • No input. The workspace is probierz config show workspace: each checkout directly under it is read with git ls-files -- .probierz.

Output and state effects#

Writes one entry per manifest as JSON without running a journey: its summary (appId, owner, file, targets, journeys), or, for a manifest that cannot be read, its appId, file and unreadable (failurePoint, errorCode, detail), beside every other product.

Exact refusals#

  • workspace-unset: no workspace is configured; run probierz config set workspace <directory>.
  • workspace-unreadable: the workspace or a repository's .probierz cannot be listed; the path and the operating system's answer are named.
  • listing-failed: a repository's git could not say which manifests it tracks.
  • untracked: a .probierz/<appId>.yaml its repository's git does not track is refused naming the file, never read as a registered product.
  • duplicate: two repositories declare the same appId; both files are named.
  • A manifest that cannot be read does not hide the others: the list is printed whole first, then the command fails as that manifest's refusal (for example manifest-unreadable), saying how many could not be read.

Declared refusals#

What probierz refusals list declares for this command at revision d2cd6156e8b8dc6204dab7b46ec0b34b2bb03cea (probierz 0.1.7 (revision unknown, not built from a git checkout)): each cause's id, the operation declaring it, its exit status and code, and its remedy.

  • workspace-unset (probierz.manifest.discover, exit 1, config): finding the repositories that hold product manifests: this instance names no workspace, so there is no directory of repositories to look in. run probierz config set workspace <directory holding one checkout per repository>.
  • workspace-unreadable (probierz.manifest.discover, exit 1, config): listing {workspace}: the operating system would not list it: {error}. give this user read permission on {workspace}, or set another workspace with probierz config set workspace.
  • listing-failed (probierz.manifest.discover, exit 1, config): asking the git of {repository} which manifests it tracks: {cause}. make {repository} a git repository this user can read.
  • untracked (probierz.manifest.discover, exit 1, config): reading the manifests of {repository}: {file} is not tracked by the repository's git, so no other host and no review sees it. run git -C {repository} add {relative} and commit it, or remove the file.
  • duplicate (probierz.manifest.discover, exit 1, config): finding the manifest of {app}: two repositories declare {app}: {first} and {second}. keep the manifest of {app} in the product's own repository and remove the other.
  • not-found (probierz.manifest.discover, exit 1, config): finding the manifest of {app}: no repository under {workspace} has .probierz/{app}.yaml. add .probierz/{app}.yaml to the product's repository (probierz project adopt or probierz author manifest write it), or name an app probierz apps list lists.
  • file-name-invalid (probierz.manifest.discover, exit 1, config): finding the manifests of {repository}: {file} names app "{app}", which is not an id: letters, digits, '.', '_' and '-', starting with a letter or digit. rename it .probierz/<appId>.yaml with the id it declares, with git mv.
  • repository-name-invalid (probierz.manifest.discover, exit 1, config): finding repository "{name}" in the workspace: a manifest names a checkout directly under the workspace, and "{name}" would name another place. name the checkout by its directory name under the workspace in repositories[].repository.

Source snapshot#

Generated from the Rust binaries at revision 99a74945a3598a8d73b6c6cbe5aae4f283becea3 of Probierz's private source repository.

Combined help SHA-256: 77529678a61237f774b59e76df0d1907cb749ef5da56d2ed913b040793b7d30b; binary SHA-256: be9e0eaff0e6ea50403a0c6f6d467697a4eac676f9523b8dc13a596d2b5526c5.