CLIリファレンス
このページではコマンドラインツールのドキュメントを提供しています。
artefacts
ARTEFACTSと連携するコマンドラインツール
使用方法:
artefacts [オプション] COMMAND [ARGS]...
オプション:
--version バージョンを表示して終了します。
--help このメッセージを表示して終了します。
config
使用方法:
artefacts config [オプション] COMMAND [ARGS]...
オプション:
--help このメッセージを表示して終了します。
add
PROJECT_NAMEの設定を行います
使用方法:
artefacts config add [オプション] PROJECT_NAME
オプション:
--help このメッセージを表示して終了します。
delete
PROJECT_NAMEの設定を削除します
使用方法:
artefacts config delete [オプション] PROJECT_NAME
オプション:
--help このメッセージを表示して終了します。
path
設定ファイルのパスを取得します
使用方法:
artefacts config path [オプション]
オプション:
--help このメッセージを表示して終了します。
containers
使用方法:
artefacts containers [オプション] COMMAND [ARGS]...
オプション:
--debug / --no-debug
--help このメッセージを表示して終了します。
build
使用方法:
artefacts containers build [オプション]
オプション:
--path TEXT [バージョン0.8.0から非推奨; --rootを参照してください] プロジェクトのルートへのパス。
--root TEXT プロジェクトのルートへのパス。
--dockerfile TEXT カスタムDockerfileへのパス。デフォルトでは`path`（同名のオプション参照）配下のDockerfileになります。
--name TEXT [バージョン0.8.0から非推奨; 使用されておらず0.8.0以降に削除されます] 生成されるイメージの名前
--config TEXT Artefacts設定ファイルへのパス。デフォルトは`./artefacts.yaml`です。
--only OPTIONAL 理するジョブ名のオプションリスト。デフォルトでは全てのジョブを処理します。
--help このメッセージを表示して終了します。
check
使用方法:
artefacts containers check [オプション] IMAGE_NAME
オプション:
--help このメッセージを表示して終了します。
run
使用方法:
artefacts containers run [オプション] JOBNAME [ENGINE_ARGS]...
オプション:
--config TEXT Artefacts設定ファイルへのパス。デフォルトは`./artefacts.yaml`です。
--with-gui BOOLEAN テスト実行によって作成されるGUIがあれば表示します。デフォルトでは
UI要素は実行されますが非表示となり、テストログのみが返されます。
GUIはしばしばX11環境（典型的にはQt）を前提としているため、適切な環境がなければ作動しない場合があることにご注意ください。
--help このメッセージを表示して終了します。
hello
PROJECT_NAMEへのアクセス権限があることを確認するメッセージを表示します
使用方法:
artefacts hello [オプション] PROJECT_NAME
オプション:
--help このメッセージを表示して終了します。
run
JOBNAMEをローカルで実行します
- デフォルトではシェル内で直接実行。
- –in-containerオプションを使用場合はパッケージ化されたコンテナ内で実行。
コンテナモードでは：
- イメージが存在しない場合は自動的にビルドされます。
- 現在はartefacts.yaml内で見つかるジョブごとに1つのイメージ。
- イメージは実行ごとに再ビルドされます（変更がなければ比較的高速）。
dockerfileで代替Dockerfileを指定できます。
使用方法:
artefacts run [オプション] JOBNAME [CONTAINER_ENGINE_ARGS]...
オプション:
--config TEXT Artefacts設定ファイル。
--dryrun トラッキングもテスト実行も行わずに実行します
--nosim Artefactsが提供するシミュレータリソースの設定をスキップします
--noupload 実行中に生成されたファイル（例：rosbag）をArtefactsにアップロードしません
--noisolation テストスイートとホスト間の「ミドルウェアネットワーク」の分離を解除します
（ROS1では：--reuse-masterフラグ、ROS2では：--disable-isolationフラグ）。
主にデバッグ用です
--description TEXT この実行のためのオプションの説明
--skip-validation 設定の検証をスキップし、非ROSの設定やSAPIENなどのシミュレーターなど、
サポートされていない設定を試すことができます。
--in-container [実験的] ジョブをパッケージコンテナ内で実行します。コンテナイメージが存在しない場合はビルドされ、
デフォルト名は「artefacts」です（イメージ名を上書きするには--with-imageを使用してください）。
このオプションは（現時点では）--dryrun、--nosim、--noisolation、--descriptionを上書きします。
--dockerfile TEXT [実験的] カスタムDockerfileへのパス。デフォルトでは実行ディレクトリのDockerfileです。
このフラグは`--in-container`と一緒に使用する場合のみ有効です。
--with-image TEXT [バージョン0.8.0から非推奨かつ未使用; イメージ名は現在内部で管理されています]
ここで渡されたイメージ名を使用してジョブを実行します。`--in-container`
が設定されている場合のみ使用されます。
--no-rebuild [実験的] コンテナイメージを常に再ビルドするというデフォルトの動作を上書きします
（増分テストを想定しているため）。
--with-gui テスト実行によって作成されるGUIがあれば表示します。デフォルトでは、UI要素は実行されますが非表示となり、
テストログのみが返されます。GUIはしばしばX11（例：ROS）、典型的にはQtを前提としているため、適切な環境がなければ作動しない場合があることにご注意ください。
--help このメッセージを表示して終了します。
run-remote
ローカルソースをパッケージ化してクラウドでJOBNAMEを実行します。.artefactsignore
ファイルが存在する場合、ソースパッケージからファイルを除外するために使用されます。
使用方法:
artefacts run-remote [オプション] JOBNAME
オプション:
--config TEXT Artefacts設定ファイル。
--description TEXT この実行のオプション説明
--skip-validation 設定の検証をスキップし、非ROSの設定やSAPIENなどのシミュレーターなど、
サポートされていない設定を試すことができます。
--help このメッセージを表示して終了します。