Skip to content

Install Helper Script

Helper Script allows to install latest official builds and many useful features.

It's completely automated, necessary changes are made automatically when installing a feature and restored after uninstallation.

When the script is updated, installed files are automatically updated as well.

Warning

FOR K1 SERIES: ONLY USE THIS SCRIPT WITH FIRMWARE 1.3.3.5 AND ABOVE!
FOR KE SERIES: ONLY USE THIS SCRIPT WITH FIRMWARE 1.1.0.12 AND ABOVE!
FOR ENDER-3 V3 SERIES: ONLY USE THIS SCRIPT WITH FIRMWARE 1.2.1.3 AND ABOVE!

Note

Please restore firmware to factory settings before using script to avoid issue.
See: Reset Factory Settings section.

Installation

If you have already installed Moonraker, Fluidd or Mainsail provided by Creality, please uninstall them first using [Remove] Menu.

  • Connect to SSH (Guide is available here).

  • Enter the following command to install script in usr/data folder:

    git clone https://github.com/Guilouz/Creality-Helper-Script.git /usr/data/helper-script

  • And enter this command to run the script:

    sh /usr/data/helper-script/helper.sh


  • If you encounter an issue to clone Helper Script repository, enter this command before cloning:

    git config --global http.sslVerify false

  • Also, make sure your system date and time are correct. See Change Date & Time section.

Note

Some features are not available for KE Series.

Update

Creality Helper Script can be updated in two ways:

  • Directly from the script at startup:

  • In Update Manager from the Web interface:

    From Fluidd in Settings tab → Software Updates
    From Mainsail in MACHINE tab

This is the main menu:

Install Menu

This menu allows you to install various useful features:

Remove Menu

This menu allows you to remove installed features:

Customize Menu

This menu allows you to customize your printer:

Backup & Restore Menu

This menu allows you to backup and restore your configuration files:

Tools Menu

This menu allows you to perform different actions:

Information Menu

This menu allows you to know what is installed or not on the printer:

System Menu

This menu allows you to have different information about the printer:


If you like my work, don't hesitate to support me by paying me a 🍺 or a ☕. Thank you 🙂