Getting Started

Dependencies & installation

This project depends on

• Python 3

• distro Python 3 package

• jsonschema Python 3 package

• PyYAML Python 3 package

• GitPython Python 3 package

• kconfiglib Python 3 package (optional, for menu plugin)

• NEWT Python 3 distro package (optional, for menu plugin)

To install kas into your python site-package repository, run:

$ sudo pip3 install .

Usage

There are (at least) three options for using kas:

• Install it locally via pip to get the kas command.

• Use the container image locally. In this case, download the kas-container script from the kas repository and use it in place of the kas command. The script version corresponds to the kas tool and the kas image version.

• Use the container image in CI. Specify ghcr.io/siemens/kas/kas[-isar][:<x.y>] in your CI script that requests a container image as runtime environment.

Start build:

$ kas build /path/to/kas-project.yml

Alternatively, experienced bitbake users can invoke usual bitbake steps manually, e.g.:

$ kas shell /path/to/kas-project.yml -c 'bitbake dosfsutils-native'

For details about the kas input file(s), see Project Configuration. Example configurations can be found in Example project configurations.

Note

kas will place downloads and build artifacts under the current directory when being invoked. You can specify a different location via the environment variable KAS_WORK_DIR.

Use Cases

1. Initial build/setup:

   $ mkdir $PROJECT_DIR
   $ cd $PROJECT_DIR
   $ git clone $PROJECT_URL meta-project
   $ kas build meta-project/kas-project.yml
   

2. Update/rebuild:

   $ cd $PROJECT_DIR/meta-project
   $ git pull
   $ kas build kas-project.yml
   

3. Interactive configuration:

   $ cd $PROJECT_DIR/meta-project
   $ kas menu
   $ kas build  # optional, if not triggered via kas menu