Open-source project
dw-0/kiauh avatar
dw-0/kiauh

KIAUH: installing Klipper, Moonraker and a web UI from one menu

Klipper Installation And Update Helper

4,596 stars643 forksPythonGPL-3.0

At a glance

What is it?
KIAUH is a Python installation script for Klipper-based 3D printer hosts. It bundles the install and update steps for Klipper, Moonraker, Mainsail, Fluidd and KlipperScreen into a numbered menu, and it expects you to already have a working Linux system.
Who is it for?
KIAUH suits anyone standing up a Klipper host on Raspberry Pi OS Lite or a similar Debian-based image who would rather answer menu prompts than follow five separate install guides. It is the wrong tool if your printer host is a locked-down appliance image that already ships Klipper, or if you want a declarative, reproducible configuration you can commit to a repository.
Can I use it commercially?
Yes, with conditions. GPL-3.0 is a copyleft licence: if you distribute software that includes it, you must release that software's source code under the same licence. Running it internally without distributing it does not trigger that obligation.
Is it still maintained?
Yes. The repository last received commits 5 days ago.
What is it written in?
Mainly Python, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • dw-0/kiauh4,596 ★ · +59
Star history
Repository2026-09-232026-11-15
dw-0/kiauh4.5k4.6k

59 Stars in the last 53 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

What KIAUH solves for Klipper users

Klipper is not a single program. A working setup needs the Klipper firmware host, Moonraker as the API layer, and usually a web interface such as Mainsail or Fluidd, plus optional pieces like KlipperScreen for a touch display. Each of those lives in its own repository with its own install steps, and the order matters. KIAUH exists to collapse that sequence into one menu.

The README describes it plainly as "a handy installation script that makes installing Klipper (and more) a breeze". The parenthetical matters: the menu covers core components (Klipper, Moonraker, Mainsail, Fluidd, KlipperScreen) and community extensions (OctoPrint, Moonraker-Telegram-Bot, PrettyGCode for Klipper). If your goal is a printer host running Klipper with a browser interface and nothing else, you are the target user. If you already have a working stack and only want to change one config file, KIAUH is a heavy way to get there.

How the menu-driven installer is put together

The repository layout tells you most of the architecture. The entry point is kiauh.sh at the top level, a shell wrapper that launches the Python program. The Python code lives under kiauh/, split into components (klipper, moonraker, webui_client), core (backends, cli, menus, services, settings, instance_manager, simple_config_parser) and extensions. There is a default.kiauh.cfg at the top level, so settings are read from a config file rather than being hardcoded.

The split into components with their own services directories suggests each installable item owns its install and removal logic, while core/menus draws the numbered interface and core/instance_manager tracks what is already present. It also explains the sudo requirement: the README states that several functions need sudo privileges and that you will be asked for your password during use.

The project is not a package on PyPI in any meaningful sense. pyproject.toml carries version = "0.0.0" and its real content is tooling configuration for ruff, mypy and pytest. Installation is by git clone, not by pip install.

Installing KIAUH and running your first setup

The README assumes you already have a Linux system flashed to your SD card, and recommends Raspberry Pi OS Lite, 32-bit or 64-bit, written with the official Raspberry Pi Imager. On a different SBC such as an Orange Pi, the README tells you to source an appropriate image yourself, usually with Balena Etcher.

First, install git if it is missing. The README gives this exact command:

bash
sudo apt-get update && sudo apt-get install git -y

Next, clone the repository into your home directory:

bash
cd ~ && git clone https://github.com/dw-0/kiauh.git

Then start the script:

bash
./kiauh/kiauh.sh

You should land in the main menu. The README describes the interaction model: several actions are listed, you type the number of the action you want into the "Perform action" prompt, and you confirm with ENTER. Expect a sudo password prompt at some point during the run, since the README says several functions need elevated privileges. Plan on being present at the terminal for the menu prompts.

Where KIAUH stops being the right tool

The README carries a blunt disclaimer: "Usage of this script happens at your own risk!"

The supported surface is narrow. The README says KIAUH is mainly tested on Raspberry Pi OS Lite on Debian 10 Buster and Debian 11 Bullseye, that other Debian-based distributions like Ubuntu 20 to 22 likely work, and that Armbian has been reported to work but was not tested in detail. "Likely work" and "reported to work" are the project's own words, and they are the honest boundary. If you are on a distribution outside that family, the README's advice is simply to make sure KIAUH will be able to run on it, which puts the burden of verification on you.

The second limitation is operational. The README documents only the interactive menu, so check what the kiauh/core/cli code offers before building KIAUH into a provisioning pipeline.

KIAUH compared with MainsailOS

The most common comparison is MainsailOS, and the difference is in when the work happens. MainsailOS is a prebuilt operating system image: you flash it, and Klipper, Moonraker and Mainsail are already on the card. KIAUH is a script you run on an image you chose yourself, which then installs those same pieces.

That changes what you control. With KIAUH you pick the base image (the README steers you to Raspberry Pi OS Lite), and you decide which components go on top, including Fluidd instead of or alongside Mainsail, KlipperScreen, or community extensions like OctoPrint and Moonraker-Telegram-Bot. With a prebuilt image, those choices were made for you before you ever wrote the card, and adding something later means going back to the component's own install instructions.

The trade-off runs the other way too. A prebuilt image gives you a known-good combination that someone else already tested together. KIAUH gives you a menu, and the combination you end up with is the one you assembled. If you want the shortest path to a working printer and you have no opinion about which web UI you use, the prebuilt image is less work. If you want to choose, KIAUH is the one that asks.

Maintenance, licence and what an upgrade costs you

The repository is not archived, and the last push was on 2026-08-03. Treat that as the maintenance signal, and note that the repository has no published releases, so there is no versioned release channel to pin against. Updates come from pulling the git repository or from the update actions inside the menu itself.

The README points at docs/changelog.md with an explicit warning to check it for possible important changes. That is the upgrade path: read the changelog before pulling, because the script touches system services and a change in how a component is installed can affect an existing host. Keep your own SD card backup in case you need to roll back.

The licence is GPL-3.0. For a tool you run on your own printer host, that has no practical consequence. If you were to redistribute a modified KIAUH, or ship it inside a product image, the copyleft terms would apply to the modified script, and that is a question for your own legal review rather than something this article can settle. The bundled components are separate projects with their own licences.

Editorial conclusion

KIAUH suits anyone standing up a Klipper host on Raspberry Pi OS Lite or a similar Debian-based image who would rather answer menu prompts than follow five separate install guides. It is the wrong tool if your printer host is a locked-down appliance image that already ships Klipper, or if you want a declarative, reproducible configuration you can commit to a repository. Before you start, confirm two things: that your board runs a Debian-based image close to Bullseye, and that you have your sudo password, because the script asks for it during installation. After that, read docs/changelog.md, since the README points there for changes that may affect an existing setup.

Frequently asked questions

How do I install KIAUH on a Raspberry Pi?

Flash Raspberry Pi OS Lite with the Raspberry Pi Imager, enable SSH and Wi-Fi in the advanced options, then install git, clone the repository into your home directory and run ./kiauh/kiauh.sh. The README recommends Raspberry Pi OS Lite, 32-bit or 64-bit.

How do I run KIAUH?

After cloning the repository, run ./kiauh/kiauh.sh from your home directory. You land in the main menu, type the number of the action you want into the "Perform action" prompt, and confirm with ENTER.

How do I install Klipper using KIAUH?

Start KIAUH, then choose the Klipper install action from the main menu; Klipper is one of the core components the script manages. The README notes that several functions need sudo privileges, so you will be asked for your password during the process.

What are the differences between MainsailOS and KIAUH?

MainsailOS is a prebuilt OS image with Klipper, Moonraker and Mainsail already installed. KIAUH is a script you run on a Linux image you chose yourself, and it installs those components plus optional ones like Fluidd, KlipperScreen and community extensions.

What OS is best for Klipper with KIAUH?

The README says KIAUH is mainly tested on Raspberry Pi OS Lite with Debian 10 Buster and Debian 11 Bullseye, and recommends Raspberry Pi OS Lite for Raspberry Pi boards. Other Debian-based distributions like Ubuntu 20 to 22 likely work, and Armbian has been reported to work but was not tested in detail.

How do I access KIAUH?

KIAUH runs in a terminal, not a browser. After starting it with ./kiauh/kiauh.sh you interact with the numbered main menu by typing an action number at the "Perform action" prompt and pressing ENTER.

Official sources

  1. dw-0/kiauh on GitHub
  2. Issues
  3. License: GPL-3.0
  4. README
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/dw-0-kiauh.svg)](https://hysenlabs.com/projects/dw-0-kiauh)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/dw-0-kiauh.svg)](https://hysenlabs.com/projects/dw-0-kiauh)

Was this useful?