octopusmode / kiauh

Klipper Installation And Update Helper

Klipper Installation And Update Helper

📋 Please see the Changelog for possible important information !

📢 Disclaimer: Usage of this script happens at your own risk!

🛠️ Instructions:

For downloading this script it is necessary to have git installed.
If you haven't, please run sudo apt-get install git -y to install git first.
After git is installed, use the following commands in the given order to download and execute the script:

cd ~

git clone https://github.com/th33xitus/kiauh.git

./kiauh/kiauh.sh

🧰 Functions and Features:

Core Functions:

• Installing Klipper to your Raspberry Pi or other Debian based Linux Distribution.
• Installing of the Moonraker API (needed for Mainsail, Fluidd and KlipperScreen)
• Installing several web interfaces such as Mainsail, Fluidd, Duet Web Control or OctoPrint including their dependencies.
• Installing of KlipperScreen (OctoScreen but for Klipper!)
• Updating of all the listed installations above excluding OctoPrint. For updating OctoPrint, please use the OctoPrint interface!
• Removing of all the listed installations above.
• Backup of all the listed installations above.

Also possible:

• Build the Klipper Firmware
• Flash the MCU
• Read ID of the currently connected MCU
• and more ...

For a list of additional features please see: Feature List

❗ Notes:

• Tested only on Raspberry Pi OS Lite (Debian 10 Buster)
  • Other Debian based distributions can work
  • Reported to work on Armbian too
• During the use of this script you might be asked for your sudo password. There are several functions involved which need sudo privileges.

🌐 Sources & Further Information

For more information or instructions to the various components KIAUH can install, please check out the corresponding repositories listed below:

• ⛵Klipper by KevinOConnor
• 🌙Moonraker by Arksine
• 💨Mainsail by mainsail-crew
• 🌊Fluidd by fluidd-core
• 🕸️Duet Web Control by Duet3D
• 🕸️DWC2-for-Klipper-Socket by Stephan3
• 🖥️KlipperScreen by jordanruthe
• 🐙OctoPrint by OctoPrint
• 🔬PrettyGCode by Kragrathea
• 🤖Moonraker-Telegram-Bot by nlef

Credits

• A big thank you to lixxbox for that awesome KIAUH-Logo!
• Also a big thank you to everyone who supported my work with a Ko-fi !
• Last but not least: Thank you to all contributors and members of the Klipper Community who like and share this project!