CLI Reference

This page provides documentation for our command line tools.

artefacts

A command line tool to interface with ARTEFACTS

Usage:

artefacts [OPTIONS] COMMAND [ARGS]...

Options:

  --version  Show the version and exit.
  --help     Show this message and exit.

config

Usage:

artefacts config [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

add

Set configuration for PROJECT_NAME

Usage:

artefacts config add [OPTIONS] PROJECT_NAME

Options:

  --help  Show this message and exit.

delete

Delete configuration for PROJECT_NAME

Usage:

artefacts config delete [OPTIONS] PROJECT_NAME

Options:

  --help  Show this message and exit.

path

Get the configuration file path

Usage:

artefacts config path [OPTIONS]

Options:

  --help  Show this message and exit.

containers

Usage:

artefacts containers [OPTIONS] COMMAND [ARGS]...

Options:

  --debug / --no-debug
  --help                Show this message and exit.

build

Usage:

artefacts containers build [OPTIONS]

Options:

  --path TEXT        Path to the root of the project, where a Dockerfile is
                     available.
  --dockerfile TEXT  File name of the container definition file. Defaults to
                     the standard Dockerfile inside the project root (see
                     --path)
  --name TEXT        Name for the generated container
  --help             Show this message and exit.

check

Usage:

artefacts containers check [OPTIONS] NAME

Options:

  --help  Show this message and exit.

run

Usage:

artefacts containers run [OPTIONS] IMAGE JOBNAME

Options:

  --config TEXT       Artefacts config file.
  --with-gui BOOLEAN  Show any GUI if any is created by the test runs. By
                      default, UI elements are run but hidden---only test logs
                      are returned. Please note GUI often assume an X11
                      environment, typically with Qt, so this may not work
                      without a appropriate environment.
  --help              Show this message and exit.

hello

Show message to confirm credentials allow access to PROJECT_NAME

Usage:

artefacts hello [OPTIONS] PROJECT_NAME

Options:

  --help  Show this message and exit.

run

Run JOBNAME locally

• Directly in the shell by default.
• Inside a packaged container when using the --in-container option.

Usage:

artefacts run [OPTIONS] JOBNAME

Options:

  --config TEXT        Artefacts config file.
  --dryrun             Dryrun: no tracking or test execution
  --nosim              nosim: no simulator resource provided by Artefacts
  --noupload           noupload: rosbags are not uploaded to cloud
  --noisolation        noisolation: for debugging, break the 'middleware
                       network' isolation between the test suite and the host
                       (in ROS1: --reuse-master flag / in ROS2: --disable-
                       isolation flag)
  --description TEXT   Optional description for this run
  --skip-validation    Skip configuration validation, so that unsupported
                       settings can be tried out, e.g. non-ROS settings or
                       simulators like SAPIEN.
  --in-container       [Experimental] Run the job inside a package container.
                       The container image is build if it does not exist yet,
                       with default name as "artefacts" (please use --with-
                       image to override the image name). This option
                       overrides (for now) --dryrun, --nosim, --noisolation
                       and --description.
  --with-image TEXT    [Experimental] Run the job using the image name passed
                       here. Only used when running with --in-container set.
  --rebuild-container  [Experimental] Rebuild the container image before
                       running. This flag guarantees that the run uses the
                       latest code available when building the image, and
                       usually takes more time before the run can start (time
                       to compile and generate the image).
  --with-gui           Show any GUI if any is created by the test runs. By
                       default, UI elements are run but hidden---only test
                       logs are returned. Please note GUI often assume X11
                       (e.g. ROS), typically with Qt, so this may not work
                       without a appropriate environment.
  --help               Show this message and exit.

run-remote

Run JOBNAME in the cloud by packaging local sources. if a .artefactsignore file is present, it will be used to exclude files from the source package.

This command requires to have a linked GitHub repository

Usage:

artefacts run-remote [OPTIONS] JOBNAME

Options:

  --config TEXT       Artefacts config file.
  --description TEXT  Optional description for this run
  --skip-validation   Skip configuration validation, so that unsupported
                      settings can be tried out, e.g. non-ROS settings or
                      simulators like SAPIEN.
  --help              Show this message and exit.