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.

curl -fsSL get.klipperbackup.xyz | bash
~/klipper-backup/install.sh

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

Troubleshooting

We have found that most errors can be traced back to incorrect use of git and that deleting a special Klipper-Backup related folder (config_backup) can solve the problem. So if you encounter strange error messages, please run the script with the --fix parameter:

~/klipper-backup/script.sh --fix

If there are still problems, simply open an issue.

Media

Contributors

Thank you to everyone who has contributed to the project!

Made with contrib.rocks.