Welcome to Klipper-Backup wiki
Klipper-Backup is a script for manual or automated Klipper GitHub backups. It's lightweight, pragmatic and comfortable.
This documentation provides a complete step-by-step guide to set up Klipper-Backup 💾. This guide is specified for the implementation on a Unix system.
Getting started¶
To get started with Klipper-Backup, please jump to the installation section to see detailed instructions.
Warning
There is currently NO restore functionality on the release/main branch of klipper-backup. That feature is work in progress. Running script.sh on a brand new machine will not restore files.
Features¶
- The script does the most complex work in the background automatically
- Works perfectly with gcode macros
- Can also be executed manually in the terminal
- Supports Command-Line Arguments
- Automatic backups with cron or a service that reacts to file changes
- Switch between repositories and branches at any time
- Fully customizable with parameters
FAQ¶
Before you open an issue on GitHub or ask somewhere: Please take a quick look at the FAQ. For example, there is this article that solves most of the problems directly.
Media¶
Contributors¶
Thank you to everyone who has contributed to the project!
Made with contrib.rocks.