{"id":13611541,"url":"https://github.com/dw-0/kiauh","last_synced_at":"2025-05-13T20:13:06.361Z","repository":{"id":38399846,"uuid":"266072656","full_name":"dw-0/kiauh","owner":"dw-0","description":"Klipper Installation And Update Helper","archived":false,"fork":false,"pushed_at":"2025-05-02T18:10:15.000Z","size":2247,"stargazers_count":3798,"open_issues_count":37,"forks_count":544,"subscribers_count":85,"default_branch":"master","last_synced_at":"2025-05-06T13:12:04.819Z","etag":null,"topics":["3d-printing","fluidd","klipper","klipperscreen","mainsail","moonraker","obico","raspberry-pi","telegram"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dw-0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":"dw__0","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":"https://paypal.me/dwillner0"}},"created_at":"2020-05-22T09:34:03.000Z","updated_at":"2025-05-05T13:12:03.000Z","dependencies_parsed_at":"2023-10-28T19:34:01.976Z","dependency_job_id":"e0ca00ac-361a-44f8-a689-724d02f7f445","html_url":"https://github.com/dw-0/kiauh","commit_stats":{"total_commits":675,"total_committers":43,"mean_commits":15.69767441860465,"dds":"0.38962962962962966","last_synced_commit":"ec3f93eeda5c6a10ef588e127d26f91d42c50aa2"},"previous_names":["dw-0/kiauh"],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dw-0%2Fkiauh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dw-0%2Fkiauh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dw-0%2Fkiauh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dw-0%2Fkiauh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dw-0","download_url":"https://codeload.github.com/dw-0/kiauh/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253837406,"owners_count":21971983,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3d-printing","fluidd","klipper","klipperscreen","mainsail","moonraker","obico","raspberry-pi","telegram"],"created_at":"2024-08-01T19:01:57.293Z","updated_at":"2025-05-13T20:13:01.353Z","avatar_url":"https://github.com/dw-0.png","language":"Python","funding_links":["https://ko-fi.com/dw__0","https://paypal.me/dwillner0"],"categories":["Python"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/kiauh.png\" alt=\"KIAUH logo\" height=\"181\"\u003e\n    \u003ch1 align=\"center\"\u003eKlipper Installation And Update Helper\u003c/h1\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  A handy installation script that makes installing Klipper (and more) a breeze!\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca\u003e\u003cimg src=\"https://img.shields.io/github/license/dw-0/kiauh\"\u003e\u003c/a\u003e\n  \u003ca\u003e\u003cimg src=\"https://img.shields.io/github/stars/dw-0/kiauh\"\u003e\u003c/a\u003e\n  \u003ca\u003e\u003cimg src=\"https://img.shields.io/github/forks/dw-0/kiauh\"\u003e\u003c/a\u003e\n  \u003ca\u003e\u003cimg src=\"https://img.shields.io/github/languages/top/dw-0/kiauh?logo=gnubash\u0026logoColor=white\"\u003e\u003c/a\u003e\n  \u003ca\u003e\u003cimg src=\"https://img.shields.io/github/v/tag/dw-0/kiauh\"\u003e\u003c/a\u003e\n  \u003cbr /\u003e\n  \u003ca\u003e\u003cimg src=\"https://img.shields.io/github/last-commit/dw-0/kiauh\"\u003e\u003c/a\u003e\n  \u003ca\u003e\u003cimg src=\"https://img.shields.io/github/contributors/dw-0/kiauh\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003chr\u003e\n\n\u003ch2 align=\"center\"\u003e\n  📄️ Instructions 📄\n\u003c/h2\u003e\n\n### 📋 Prerequisites\nKIAUH is a script that assists you in installing Klipper on a Linux operating system that has\nalready been flashed to your Raspberry Pi's (or other SBC's) SD card. As a result, you must ensure\nthat you have a functional Linux system on hand. `Raspberry Pi OS Lite (either 32bit or 64bit)` is a recommended Linux image\nif you are using a Raspberry Pi. The [official Raspberry Pi Imager](https://www.raspberrypi.com/software/)\nis the simplest way to flash an image like this to an SD card.\n\n* Once you have downloaded, installed and launched the Raspberry Pi Imager,\nselect `Choose OS -\u003e Raspberry Pi OS (other)`: \\\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager1.png\" alt=\"KIAUH logo\" height=\"350\"\u003e\n\u003c/p\u003e\n\n* Then select `Raspberry Pi OS Lite (32bit)` (or 64bit if you want to use that instead):\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager2.png\" alt=\"KIAUH logo\" height=\"350\"\u003e\n\u003c/p\u003e\n\n* Back in the Raspberry Pi Imager's main menu, select the corresponding SD card to which\nyou want to flash the image.\n\n* Make sure to go into the Advanced Option (the cog icon in the lower left corner of the main menu)\nand enable SSH and configure Wi-Fi.\n\n* If you need more help for using the Raspberry Pi Imager, please visit the [official documentation](https://www.raspberrypi.com/documentation/computers/getting-started.html).\n\nThese steps **only** apply if you are actually using a Raspberry Pi. In case you want\nto use a different SBC (like an Orange Pi or any other Pi derivates), please look up on how to get an appropriate Linux image flashed\nto the SD card before proceeding further (usually done with Balena Etcher in those cases). Also make sure that KIAUH will be able to run\nand operate on the Linux Distribution you are going to flash. You likely will have the most success with\ndistributions based on Debian 11 Bullseye. Read the notes further down below in this document.\n\n### 💾 Download and use KIAUH\n**📢 Disclaimer: Usage of this script happens at your own risk!**\n\n* **Step 1:** \\\nTo download this script, it is necessary to have git installed. If you don't have git already installed, or if you are unsure, run the following command:\n```shell\nsudo apt-get update \u0026\u0026 sudo apt-get install git -y\n```\n\n* **Step 2:** \\\nOnce git is installed, use the following command to download KIAUH into your home-directory:\n\n```shell\ncd ~ \u0026\u0026 git clone https://github.com/dw-0/kiauh.git\n```\n\n* **Step 3:** \\\nFinally, start KIAUH by running the next command:\n\n```shell\n./kiauh/kiauh.sh\n```\n\n* **Step 4:** \\\nYou should now find yourself in the main menu of KIAUH. You will see several actions to choose from depending\non what you want to do. To choose an action, simply type the corresponding number into the \"Perform action\"\nprompt and confirm by hitting ENTER.\n\n\u003chr\u003e\n\n\u003ch2 align=\"center\"\u003e❗ Notes ❗\u003c/h2\u003e\n\n### **📋 Please see the [Changelog](docs/changelog.md) for possible important changes!**\n\n- Mainly tested on Raspberry Pi OS Lite (Debian 10 Buster / Debian 11 Bullseye)\n    - Other Debian based distributions (like Ubuntu 20 to 22) likely work too\n    - Reported to work on Armbian as well but not tested in detail\n- During the use of this script you will be asked for your sudo password. There are several functions involved which need sudo privileges.\n\n\u003chr\u003e\n\n\u003ch2 align=\"center\"\u003e🌐 Sources \u0026 Further Information\u003c/h2\u003e\n\n\u003ctable align=\"center\"\u003e\n\u003ctr\u003e\n    \u003cth\u003e\u003ch3\u003e\u003ca href=\"https://github.com/Klipper3d/klipper\"\u003eKlipper\u003c/a\u003e\u003c/h3\u003e\u003c/th\u003e\n    \u003cth\u003e\u003ch3\u003e\u003ca href=\"https://github.com/Arksine/moonraker\"\u003eMoonraker\u003c/a\u003e\u003c/h3\u003e\u003c/th\u003e\n    \u003cth\u003e\u003ch3\u003e\u003ca href=\"https://github.com/mainsail-crew/mainsail\"\u003eMainsail\u003c/a\u003e\u003c/h3\u003e\u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n    \u003cth\u003e\u003cimg src=\"https://raw.githubusercontent.com/Klipper3d/klipper/master/docs/img/klipper-logo.png\" alt=\"Klipper Logo\" height=\"64\"\u003e\u003c/th\u003e\n    \u003cth\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/9563098?v=4\" alt=\"Arksine avatar\" height=\"64\"\u003e\u003c/th\u003e\n    \u003cth\u003e\u003cimg src=\"https://raw.githubusercontent.com/mainsail-crew/docs/master/assets/img/logo.png\" alt=\"Mainsail Logo\" height=\"64\"\u003e\u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n    \u003cth\u003eby \u003ca href=\"https://github.com/KevinOConnor\"\u003eKevinOConnor\u003c/a\u003e\u003c/th\u003e\n    \u003cth\u003eby \u003ca href=\"https://github.com/Arksine\"\u003eArksine\u003c/a\u003e\u003c/th\u003e\n    \u003cth\u003eby \u003ca href=\"https://github.com/mainsail-crew\"\u003emainsail-crew\u003c/a\u003e\u003c/th\u003e\n\u003c/tr\u003e\n\n\u003ctr\u003e\n    \u003cth\u003e\u003ch3\u003e\u003ca href=\"https://github.com/fluidd-core/fluidd\"\u003eFluidd\u003c/a\u003e\u003c/h3\u003e\u003c/th\u003e\n    \u003cth\u003e\u003ch3\u003e\u003ca href=\"https://github.com/jordanruthe/KlipperScreen\"\u003eKlipperScreen\u003c/a\u003e\u003c/h3\u003e\u003c/th\u003e\n    \u003cth\u003e\u003ch3\u003e\u003ca href=\"https://github.com/OctoPrint/OctoPrint\"\u003eOctoPrint\u003c/a\u003e\u003c/h3\u003e\u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n    \u003cth\u003e\u003cimg src=\"https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/assets/images/logo.svg\" alt=\"Fluidd Logo\" height=\"64\"\u003e\u003c/th\u003e\n    \u003cth\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/31575189?v=4\" alt=\"jordanruthe avatar\" height=\"64\"\u003e\u003c/th\u003e\n    \u003cth\u003e\u003cimg src=\"https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png\" alt=\"OctoPrint Logo\" height=\"64\"\u003e\u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n    \u003cth\u003eby \u003ca href=\"https://github.com/fluidd-core\"\u003efluidd-core\u003c/a\u003e\u003c/th\u003e\n    \u003cth\u003eby \u003ca href=\"https://github.com/jordanruthe\"\u003ejordanruthe\u003c/a\u003e\u003c/th\u003e\n    \u003cth\u003eby \u003ca href=\"https://github.com/OctoPrint\"\u003eOctoPrint\u003c/a\u003e\u003c/th\u003e\n\u003c/tr\u003e\n\n\u003ctr\u003e\n    \u003cth\u003e\u003ch3\u003e\u003ca href=\"https://github.com/nlef/moonraker-telegram-bot\"\u003eMoonraker-Telegram-Bot\u003c/a\u003e\u003c/h3\u003e\u003c/th\u003e\n    \u003cth\u003e\u003ch3\u003e\u003ca href=\"https://github.com/Kragrathea/pgcode\"\u003ePrettyGCode for Klipper\u003c/a\u003e\u003c/h3\u003e\u003c/th\u003e\n    \u003cth\u003e\u003ch3\u003e\u003ca href=\"https://github.com/TheSpaghettiDetective/moonraker-obico\"\u003eObico for Klipper\u003c/a\u003e\u003c/h3\u003e\u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n    \u003cth\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/52351624?v=4\" alt=\"nlef avatar\" height=\"64\"\u003e\u003c/th\u003e\n    \u003cth\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/5917231?v=4\" alt=\"Kragrathea avatar\" height=\"64\"\u003e\u003c/th\u003e\n    \u003cth\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/46323662?s=200\u0026v=4\" alt=\"Obico logo\" height=\"64\"\u003e\u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n    \u003cth\u003eby \u003ca href=\"https://github.com/nlef\"\u003enlef\u003c/a\u003e\u003c/th\u003e\n    \u003cth\u003eby \u003ca href=\"https://github.com/Kragrathea\"\u003eKragrathea\u003c/a\u003e\u003c/th\u003e\n    \u003cth\u003eby \u003ca href=\"https://github.com/TheSpaghettiDetective\"\u003eObico\u003c/a\u003e\u003c/th\u003e\n\u003c/tr\u003e\n\n\u003ctr\u003e\n    \u003cth\u003e\u003ch3\u003e\u003ca href=\"https://github.com/Clon1998/mobileraker_companion\"\u003eMobileraker's Companion\u003c/a\u003e\u003c/h3\u003e\u003c/th\u003e\n    \u003cth\u003e\u003ch3\u003e\u003ca href=\"https://octoeverywhere.com/?source=kiauh_readme\"\u003eOctoEverywhere For Klipper\u003c/a\u003e\u003c/h3\u003e\u003c/th\u003e\n    \u003cth\u003e\u003ch3\u003e\u003ca href=\"https://github.com/crysxd/OctoApp-Plugin\"\u003eOctoApp For Klipper\u003c/a\u003e\u003c/h3\u003e\u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n    \u003cth\u003e\u003ca href=\"https://github.com/Clon1998/mobileraker_companion\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png\" alt=\"Mobileraker Logo\" height=\"64\"\u003e\u003c/a\u003e\u003c/th\u003e\n    \u003cth\u003e\u003ca href=\"https://octoeverywhere.com/?source=kiauh_readme\"\u003e\u003cimg src=\"https://octoeverywhere.com/img/logo.svg\" alt=\"OctoEverywhere Logo\" height=\"64\"\u003e\u003c/a\u003e\u003c/th\u003e\n    \u003cth\u003e\u003ca href=\"https://octoapp.eu/?source=kiauh_readme\"\u003e\u003cimg src=\"https://octoapp.eu/octoapp.webp\" alt=\"OctoApp Logo\" height=\"64\"\u003e\u003c/a\u003e\u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n    \u003cth\u003eby \u003ca href=\"https://github.com/Clon1998\"\u003ePatrick Schmidt\u003c/a\u003e\u003c/th\u003e\n    \u003cth\u003eby \u003ca href=\"https://github.com/QuinnDamerell\"\u003eQuinn Damerell\u003c/a\u003e\u003c/th\u003e\n    \u003cth\u003eby \u003ca href=\"https://github.com/crysxd\"\u003eChristian Würthner\u003c/a\u003e\u003c/th\u003e\n\u003c/tr\u003e\n\n\u003ctr\u003e\n    \u003cth\u003e\u003ch3\u003e\u003ca href=\"https://github.com/staubgeborener/klipper-backup\"\u003eKlipper-Backup\u003c/a\u003e\u003c/h3\u003e\u003c/th\u003e\n    \u003cth\u003e\u003ch3\u003e\u003ca href=\"https://simplyprint.io/\"\u003eSimplyPrint for Klipper\u003c/a\u003e\u003c/h3\u003e\u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n    \u003cth\u003e\u003ca href=\"https://github.com/staubgeborener/klipper-backup\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/28908603?v=4\" alt=\"Staubgeroner Avatar\" height=\"64\"\u003e\u003c/a\u003e\u003c/th\u003e\n    \u003cth\u003e\u003ca href=\"https://github.com/SimplyPrint\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/64896552?s=200\u0026v=4\" alt=\"\" height=\"64\"\u003e\u003c/a\u003e\u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n    \u003cth\u003eby \u003ca href=\"https://github.com/Staubgeborener\"\u003eStaubgeborener\u003c/a\u003e\u003c/th\u003e\n    \u003cth\u003eby \u003ca href=\"https://github.com/SimplyPrint\"\u003eSimplyPrint\u003c/a\u003e\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n\u003chr\u003e\n\n\u003ch2 align=\"center\"\u003e🎖️ Contributors 🎖️\u003c/h2\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/dw-0/kiauh/graphs/contributors\"\u003e\n    \u003cimg src=\"https://contrib.rocks/image?repo=dw-0/kiauh\" alt=\"\"/\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\u003chr\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://repobeats.axiom.co/api/embed/a1afbda9190c04a90cf4bd3061e5573bc836cb05.svg\" alt=\"Repobeats analytics image\"/\u003e\n\u003c/div\u003e\n\n\u003chr\u003e\n\n\u003ch2 align=\"center\"\u003e✨ Credits ✨\u003c/h2\u003e\n\n* A big thank you to [lixxbox](https://github.com/lixxbox) for that awesome KIAUH-Logo!\n* Also, a big thank you to everyone who supported my work with a [Ko-fi](https://ko-fi.com/dw__0) !\n* Last but not least: Thank you to all contributors and members of the Klipper Community who like and share this project!\n\n\u003chr\u003e\n\n\u003ch4 align=\"center\"\u003eA special thank you to JetBrains for sponsoring this project with their incredible software!\u003c/h4\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.jetbrains.com/community/opensource/#support\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png\" alt=\"JetBrains Logo (Main) logo.\" height=\"128\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdw-0%2Fkiauh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdw-0%2Fkiauh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdw-0%2Fkiauh/lists"}