cli

Testflinger CLI

Testflinger CLI is the tool for interacting with a Testflinger server. It can be used to submit jobs, check the status of jobs, and get the job results.

Basic Usage

A test job is defined by a YAML or JSON file.

Given a job file, Testflinger submits a new test job with:

testflinger-cli submit job.yaml

After successfully submitting a job, check the status of your job with:

testflinger-cli status d14d2e31-f239-41b6-9a74-32f538e71cde

You can also watch the output of the job as it runs by polling it with:

testflinger-cli poll d14d2e31-f239-41b6-9a74-32f538e71cde

After a job is finished, you can check the results of the test with:

testflinger-cli results d14d2e31-f239-41b6-9a74-32f538e71cde

Finally, you can download the artifact tarball from the test with:

testflinger-cli artifacts d14d2e31-f239-41b6-9a74-32f538e71cde

To see a more detailed tutorial, see the Get started with Testflinger CLI tutorial.

Installation

Testflinger is available on all major Linux distributions.

On snap-ready systems, you can install it on the command-line with:

sudo snap install testflinger-cli

In order for Testflinger to access files/directories in removable media, you need to connect the removable-media interface manually:

sudo snap connect testflinger-cli:removable-media

Documentation

The Testflinger docs provide guidance and learning material about job definitions, configuring Testflinger, using authentication (for priority or restricted queues), and much more:

• Testflinger documentation on ReadTheDocs

Community and Support

You can report any issues, bugs, or feature requests on the project's GitHub repository.

Contribute to Testflinger

Testflinger is open source. Contributions are welcome.

If you're interested, start with the CLI development guide and the contribution guide.

License and Copyright

Testflinger CLI is released under the GPL-3.0 license.

© 2025 Canonical Ltd.