Usage

Currently PlainBox has no graphical user interface. To use it you need to use the command line.

Basically there is just one command that does everything we can do so far, that is plainbox run. It has a number of options that tell it which job to run and what to do with results.

PlainBox has built-in help system so running plainbox run –help will give you instant information about all the various arguments and options that are available. This document is not intended to replace that.

Running a specific job

To run a specific job pass it to the --include-pattern or -i option.

For example, to run the cpu/scaling_test job:

$ plainbox run -i cpu/scaling_test

Note

The option -i can be provided any number of times.

Running a white list

To run a white list pass the --whitelist or -w option.

For example, to run the default white list run:

$ plainbox run -w /usr/share/checkbox/data/whitelists/default.whitelist

Saving test results as XML

To generate an XML file that can be sent to the certification website you need to pass two additional options:

  1. --output-format=xml
  2. --output-file=NAME where NAME is a file name

For example, to get the default certification tests ready to be submitted run this command:

$ plainbox run --whitelist=/usr/share/checkbox/data/whitelists/default.whitelist --output-format=xml --output-file=submission.xml

Table Of Contents

Previous topic

PlainBox

Next topic

Job and Test Developers

This Page