Command Line

inkBoard provides a couple of useful commands though the command line.

Run the help function to get a description printed in your terminal:

inkBoard -h

inkBoard provides functionality to install configuration packages. These packages can be made via the designer. By running the install command with a package file, the zip file is extracted, and the internal platforms and integrations present are copied to the correct folder within the inkBoard directory. It will also take care of prompting you for any dependencies that need to be installed.

Running a specific configuration fill can be done with the run command.

inkBoard run <configuration.yaml>

The designer can be run without specifying a configuration file, although it optionally also takes that as an argument to immediately boot up a configuration. If the designer is not installed, it will instead throw an error message.

inkBoard designer

inkBoard install <my-package.zip>

Installing dependencies for already installed integrations and platforms is also possible. Respectively:

inkBoard install integration <dummy_integration>

inkBoard install platform <dummy_platform>

The version command will print the current version of inkBoard, and of the designer if it is installed.

inkBoard version