Setup Instructions

In order to install this program following instructions have to be executed in the console. Note that thereby a folder will be created in the current location. The newly created folder should not be moved, after the setup.

There are 2 ways to install this program.


Currently a bash compatible terminal and Python >= 3.7 is required.

Most Compatible Setup Instructions

git clone
chmod +x ./bin/install

Make based Installation

git clone
chmod +x ./configure
make install

Extend Functionality

Congratulations! Now you can do nothing! On a more serious ;) This framework primarily provides a set of commands in order to do things independent from technical details. This set of commands define an interface, but does not contain the concrete implementation for these commands.

For this additional repositories/projects has to be installed. These provide the implementations for the different operation systems. A list of such repositories can be found here.

This can be done in the following ways in the terminal:

# Find and download a repository that fits for this framework.
git clone <URL>
# Enter the newly downloaded repository.
cd <New clone of repository>
# Register the new repository.
command.repository.register $(pwd)
# Install the new repository.

The repo of OS state interface also contains such a project and is named net.splitcells.os.state.interface.lib. It contains implementations, which depend on software, that can be linked without license issues (permissive licenses and weak copy left licenses). The project can be installed with the following commands:

cd <main repo folder>/projects/net.splitcells.os.state.interface.lib
command.repository.register $(pwd)

Command Documentation

The manuals for each commands can be viewed via "man ".


One can enable extended logging by setting the environment variable 'log_level' to 'debug': 'export log_level=debug'

End Your Adventure

So you decided that enough is enough? You want to get rid of the program? Go on.

  • SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
  • SPDX-FileCopyrightText: Contributors To The net.splitcells.* Projects