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.
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
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
--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.
--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.