kci-dev

Stand alone tool for Linux Kernel developers and maintainers to interact with KernelCI.

Purpose of this tool to provide an easy-to-use command line tool for developers and maintainers request test from KernelCI, view results, download logs, integrate with scripts, etc.

Installation

You may want to use python virtual environment. If you are not familiar with it, check this.

To quickly setup it:

virtualenv .venv
source .venv/bin/activate

Using package from PyPI

Simply install it using pip:

pip install kci-dev

Development snapshot through poetry

Clone the kci-dev repo you want, select the desired branch and run:

virtualenv .venv
source .venv/bin/activate
pip install poetry
poetry install

Then, to execute kci-dev:

poetry run kci-dev <options>

Configuration

Configuration is only necessary if you are using any of the Maestro Commands listed in the Maestro section.

The following command will create a config file template under ~/.config/kci-dev/kci-dev.toml

kci-dev config

For more explanation about kci-dev config
For more explantiion about the config file

Config file parameters

Config file kci-dev.toml parameters and example can be seen here

Configuration options

–instance

You can provide the instance name to use for the command.

Example:

kci-dev --instance staging

–settings

You can provide the configuration file path to use for the command.

Example:

kci-dev --settings /path/to/.kci-dev.toml

General Commands

results

Pull results from the Web Dashboard. See detailed documentation.

Maestro Commands

config

Setup the base config for talking to the maestro API. See Configuration section above.

• config

checkout

Trigger ad-hoc test of specific tree/branch/commit.

• checkout

testretry

Trigger a test retry for a given Maestro node id.

• testretry

watch

Watch for the results of a given node id.

• watch

maestro-results

Pull Maestro results in the json format.

• maestro-results