Installing buildtest


You need the following packages to install buildtest.

Cloning buildtest

To get started, clone the buildtest repository in your local machine as follows:

$ git clone

$ git clone

If you prefer the latest release use the master branch:

$ git clone -b master

Installing buildtest

To install buildtest, navigate to buildtest repo and source the setup script as follows:

# BASH users
$ source

# CSH users
$ source setup.csh

This will add buildtest command in your $PATH and set environment variable $BUILDTEST_ROOT which points to root of buildtest repo.

You may want to create an isolated python environment of choice depending on your preference you can use any of the following:

buildtest will provide tab completion for bash shell, this is managed by script, if you encounter any issues with tab completion please raise an issue at

Development Dependencies (Optional)

If you plan to contribute back to buildtest, you will need to install additional dependencies as follows:

$ pip install -r docs/requirements.txt

Usage (buildtest --help)

Once you are setup, you can run buildtest --help for more details on how to use buildtest. Shown below is the output

$ buildtest --help
usage: buildtest [options] [COMMANDS]

buildtest is a HPC testing framework for building and running tests.

optional arguments:
  -h, --help            show this help message and exit
  -V, --version         show program's version number and exit
                        Specify Path to Configuration File
  -d, --debug           Print debug messages to screen

    build               Build and Run test
    history             Query build history
    buildspec           Options for querying buildspec cache
    config              Query buildtest configuration
    report              Query test report
    inspect             Inspect a test based on NAME or ID
    schema              List schema contents and examples
    cdash               Upload test to CDASH server
    docs                Open buildtest docs in browser
    schemadocs          Open buildtest schema docs in browser
    help                buildtest command guide

Schema Documentation:

Please report issues at

Copyright (c) 2021, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy), Shahzeb Siddiqui, and Vanessa Sochat. All rights reserved.

If you have got this far, please go to the next section on Getting Started