@doctolib/argos-cli

argos-cli

Argos command line interface.

Usage

Usage: argos [options] [command]


Commands:

  upload [options] <directory>  Upload screenshots

Options:

  -h, --help     output usage information
  -V, --version  output the version number

Upload

Usage: upload [options] <directory>

Upload screenshots

Options:

  -h, --help             output usage information
  -C, --commit <commit>  Git commit
  -B, --branch <branch>  Git branch
  -T, --token <token>    Repository token
  --buildId [string]     (Optional) Build ID
  --batchId [string]     (Optional) Batch ID
  --batchTotal [int]     (Optional) Total number of batches
  --ignore <list>        List of glob files to ignore (ex: "**/*.png,**/diff.jpg")

The buildId, batchId and batchTotal options make it possible to perform screenshot uploads in several batches for a single build.

This is especially useful when screenshots come from different machines:

argos upload --buildId 123 --batchId 0 --batchTotal 2 path/to/screenshots # On machine A
argos upload --buildId 123 --batchId 1 --batchTotal 2 path/to/screenshots # On machine B

Argos will assume that all screenshots have been uploaded once the number of uploaded batches equals the number of batches given by the batchTotal option.

License

MIT