Skip to content

Getting Started with Artefacts

Creating an account

You will need a github account. Then go to and proceed.

CLI installation

Using python3, preferably in a virtual environment:

pip install artefacts-client --extra-index-url -U

Usage reference

For CLI usage, refer to the CLI reference

For the yaml configuration, refer to the Configuration file syntax

For reference about naming and file placement when writing tests with ROS1, see Writing ROS1 Tests


For writing tests with ROS1, see Automating Regression tests and Tuning Parameters with Artefacts

For writing tests with ROS2, see the ros-2-simulation-workflows repository