CLI command

probierz baseline

Accepted screens a run is compared with, kept in the product's repository.

Invocation#

Shell
probierz baseline <accept|list|show|remove>

Required inputs and options#

  • The leaf must be one of accept, list, show, remove.

Output and state effects#

The group dispatches to the selected leaf.

Exact refusals#

  • Missing or unknown leaves return the group usage and exit 2.

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.

  • json-unreadable (probierz.records.json, exit 1, config): reading {file}: the file cannot be read: {error}. make {file} readable to this user.
  • json-malformed (probierz.records.json, exit 1, config): reading {file}: the file does not hold JSON: {error}. write {file} again as the command that made it does, or remove it.
  • json-missing (probierz.records.json, exit 1, not_found): reading {file}: no file is there, and the command needs it. name a file that is there.
  • run-unknown (probierz.records.run, exit 1, not_found): reading run {run} of {app}: no run of that id is recorded for {app}. name a run probierz history {app} lists.
  • run-record-incomplete (probierz.records.run, exit 1, config): reading when the run recorded at {file} expires: the run record {problem}. a run Probierz records states its kind and when it started and completed as RFC 3339 times: restore the record from its bundle with probierz restore, or name its kind after the run id where the command takes one (probierz protect <appId> <runId> <kind>).
  • state-blank (probierz.config, exit 1, config): finding Probierz's state directory: PROBIERZ_STATE_DIR is set but blank, so it names no directory. set PROBIERZ_STATE_DIR to an absolute directory, or unset it so .probierz in the home directory is used.
  • state-relative (probierz.config, exit 1, config): finding Probierz's state directory: PROBIERZ_STATE_DIR names {path}, which is not an absolute path, so it would mean a different directory in every working directory. set PROBIERZ_STATE_DIR to an absolute directory.
  • unreadable (probierz.config, exit 1, config): reading this instance's configuration at {file}: the file cannot be read: {error}. make {file} a file this user can read, or remove it to set no key.
  • malformed (probierz.config, exit 1, config): reading this instance's configuration at {file}: the file is not a JSON object of keys: {error}. write {file} again with probierz config set, or remove it to set no key.
  • stored-unknown (probierz.config, exit 1, config): reading this instance's configuration at {file}: it holds {key}, which no part of this Probierz reads (a key a release before or after this one declared). remove it with probierz config unset {key}.
  • stored-invalid (probierz.config, exit 1, config): reading {key} from this instance's configuration at {file}: it holds {value}, which is not a {kind}. set it again with probierz config set {key} <value>, or remove it with probierz config unset {key}.
  • unwritable (probierz.config, exit 1, config): writing this instance's configuration at {file}: {step} failed: {error}. make {directory} a directory this user can write, or point PROBIERZ_STATE_DIR at one.
  • key-unknown (probierz.config, exit 2, refused): naming a configuration key: {key} is no key any part of Probierz reads. name one of the listed keys; probierz config list prints what each decides.
  • value-invalid (probierz.config, exit 2, refused): setting {key}: {value} is not a {kind}: {why}. give {key} a {kind}.
  • 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.
  • stado-missing (probierz.alternatives, exit 1, config): asking Stado which alternative answers: {command}: Stado could not be started: {error}. install Stado (the stado release installer at stado://releases/stado/<version>/<platform>/install.sh) so its alternatives can be asked.
  • none-answers (probierz.alternatives, exit 69, infra_down): finding an alternative of {family} for Probierz: no alternative answered {command}: {cause}. make one of the alternatives Stado names answer (stado capabilities list {family}), or select another order with stado capabilities select {family}.
  • answer-malformed (probierz.alternatives, exit 1, config): reading Stado's answer to {command}: {error}. update Stado to the release whose answer Probierz reads (stado product update stado).
  • program-failed (probierz.alternatives, exit 1, refused): {command}: {cause}. fix what the provider names, or ask Stado for the next alternative with stado capabilities resolve --failed <provider>.
  • placement-unset (probierz.alternatives, exit 1, config): opening a browser: this instance has not decided where a browser may run (browser.placement). run probierz config set browser.placement stado (only on a host Stado places the run on) or local.
  • placement-refused (probierz.alternatives, exit 1, refused): opening a browser: browser.placement is stado and this process is not a job Stado placed. run it through Stado: probierz remote run web --app <app> --host <host>, or the same verb under probierz remote.
  • no-journey (probierz.baseline, exit 1, refused): accepting the screens of run {run} of {app} as baselines: the run carried no journey, so its screens are no journey's baseline. accept the screens of a run of the journey they show.
  • no-screens (probierz.baseline, exit 1, not_found): accepting the screens of run {run} of {app} as baselines: the run kept no screens/<name>.png in {artifacts}. have the journey save each screen it judges as screens/<name>.png in its artifacts, then run it again.
  • no-target (probierz.baseline, exit 1, refused): placing the screens of run {run} in a matrix cell: the run names no target, so its screens were drawn in no cell a baseline is kept for. accept the screens of a run its surface recorded, which names its target.
  • baseline-unwritable (probierz.baseline, exit 1, config): accepting the screens of run {run} of {app} as baselines: {path} cannot be written: {error}. make the product's .probierz/{app}/ writable to this user, then accept again.
  • baselines-unreadable (probierz.baseline, exit 1, config): reading the baselines of {app}: {path} cannot be read: {error}. make {path} readable to this user; it is in the product's repository.
  • baseline-unknown (probierz.baseline, exit 1, not_found): finding the baseline {screen} of {app}: no accepted baseline has that name. name one probierz baseline list {app} shows, or accept one with probierz baseline accept.

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.