Skip to main content

Artefacts CLI

CLI to the Artefacts platform.

Documentation Ruff Style

Status

Local Runs

Requirements

  • Currently working partially where Python can run.
  • Fully working on ROS-compatible and ready environments. Notably need for packages like ros-<dist>-rclpy and ros-<dist>-rosidl-runtime-py.

Usage

To install:

pip install artefacts-cli

Check configuration: After creating project-name from the web UI and getting an API key, try:

artefacts config add [project-name]

and enter you API_KEY for the project when prompted.

You can then do

artefacts hello [project-name]

alternatively, you can specify you API KEY via environment variable

ARTEFACTS_KEY=[your-key] artefacts hello [project-name]

To run a job locally, for example the turtlesim example (need ros2 installed). First edit artefacts.yaml to change the project name, then:

cd examples/turtlesim
artefacts run basic_tests

Configuration file syntax

See the configuration syntax documentation

User docs

You can serve docs locally using mkdocs:

mkdocs serve -a 127.0.0.1:7000

The docs are automatically deployed by the documentation workflow.

Development notes

  • After installing the dependencies, pre-commit is available to register our code checks. We suggest to register: pre-commit install
  • We use Pyre for static analysis. If it does not work out of the box, please consider adapting the .pyre_configuration file included with this repository. One assumption is that developers work in a virtual environment under ./venv.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

artefacts_cli-0.17.1.tar.gz (176.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

artefacts_cli-0.17.1-py3-none-any.whl (175.4 kB view details)

Uploaded Python 3

File details

Details for the file artefacts_cli-0.17.1.tar.gz.

File metadata

  • Download URL: artefacts_cli-0.17.1.tar.gz
  • Upload date:
  • Size: 176.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for artefacts_cli-0.17.1.tar.gz
Algorithm Hash digest
SHA256 1d20def0b3785f1978ab602c61469bcd5427266de74ad8ae12a3c19a489ea93d
MD5 f7d5012cf6c11bfc895326025f2af73d
BLAKE2b-256 a7ba911c0b96afa371579782bfad369bb1be54a7cb7c4cb6748712b3d7e6a639

See more details on using hashes here.

File details

Details for the file artefacts_cli-0.17.1-py3-none-any.whl.

File metadata

  • Download URL: artefacts_cli-0.17.1-py3-none-any.whl
  • Upload date:
  • Size: 175.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for artefacts_cli-0.17.1-py3-none-any.whl
Algorithm Hash digest
SHA256 182b20e265e575c4a7e5be7ea0c2426bd6b267a1919c70ae10f499d1845530a0
MD5 cc317ad9eb0cf32b7cb88f95c040e13a
BLAKE2b-256 55ac9f64008f6958ef50e8fdf266d75e7746c3cb1556265f9d4e00360dc00826

See more details on using hashes here.

Release history Release notifications | RSS feed

0.17.2

2 files

This release

0.17.1 This release

2 files

0.17.0

2 files

0.16.2

2 files

0.16.1

2 files

0.16.0

2 files

0.15.0

2 files

0.14.0

2 files

0.13.0

2 files

0.12.0

2 files

0.11.0

2 files

0.10.2

2 files

0.10.1

2 files

0.10.0

2 files

0.9.9

1 file

0.9.8

1 file

0.9.7

1 file

0.9.6

2 files

0.9.5

2 files

0.9.3

2 files

0.9.2

2 files

0.9.1

1 file

0.8.0

2 files

0.7.3

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.19

2 files

0.6.18

2 files

0.6.17

2 files

0.6.16

2 files

0.6.15

1 file

0.6.13

2 files

0.6.12

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page