How to Install Creality Helper Script on Creality 3D Printers
Install Creality Helper Script on supported Creality K1 and Ender-3 V3 printers, enable root access, connect over SSH, and install useful Klipper features such as M600 and Moonraker with Fluidd or Mainsail.
How to Install Creality Helper Script on Creality 3D Printers Creality Helper Script is a community-maintained script for rooted Creality printers that adds features and makes it easier to manage parts of the printer’s Klipper-based software stack. The official project and wiki are maintained by Guilouz. ## What printers is this for? The main Creality Helper Script project supports the following printer families: ### Creality K1 Series - Creality K1
- Creality K1 Max
- Creality K1C ### Creality Ender-3 V3 Series - Ender-3 V3
- Ender-3 V3 KE
- Ender-3 V3 SE Do not assume that another Creality printer is compatible just because it runs Klipper or has a similar interface. The official Helper Script repository specifically targets the K1 and Ender-3 V3 series. K1 SE and newer K2-series printers are not covered by this guide or the main Helper Script project. Firmware requirements also matter. The Helper Script wiki currently specifies firmware 1.3.3.5 or newer for the K1 series, 1.1.0.12 or newer for the KE series, and 1.2.1.3 or newer for the Ender-3 V3 series. Check the official Helper Script installation page before proceeding because compatibility can change as the project develops. ## Optional: Factory reset if you have already rooted the printer The official Helper Script documentation recommends restoring the printer to factory settings before installing the script. This is particularly relevant if you have already rooted the printer or manually installed other modifications. The normal screen factory reset is only a partial reset. If you already have root and SSH access, I recommend using the SSH factory-reset method from the Helper Script documentation instead. The Helper Script wiki provides the following full-reset command:
bash echo "all" | nc -U /var/run/wipe.sockAfter the reset, you will need to reconnect the printer to your network fromSettings→Networkand re-enable root access. The reset removes previously installed Helper Script features, so they will need to be installed again. There is also a USB factory-reset method in the official documentation, but I found the USB reset file did not work reliably. Use the SSH method if you already have working root access. See the official factory-reset documentation for the current reset methods. ## Get Creality Helper Script The official download/source repository is: Creality Helper Script on GitHub If you are preparing a USB drive because you need to move files between your computer and printer, keep the drive formatted in a filesystem the printer can read and use the files supplied by the official Helper Script documentation. Do not download a random fork or modified copy when the official repository is available. For the normal Helper Script installation, the important files are actually copied to the printer over SSH. You do not need to install the script by puttinghelper.shon a USB drive. ## Enable the root account Before you can SSH into the printer, enable root access from the printer’s touchscreen. On the printer, open: Settings → Root account information Read the disclaimer, check the agreement box, wait the required 30 seconds, and pressOK. The printer will then display the root credentials. Use the credentials displayed by your printer rather than copying credentials from another model or guide. ## Find your printer’s IP address On the printer, open the network settings and find its local IP address. You will use that address to connect to the printer over SSH. From Linux or macOS, the connection will look like:bash ssh [email protected]Replace192.168.1.100with the IP address shown on your printer. Windows 10 and 11 also include an SSH client, so the same command can be run from PowerShell or Command Prompt. When prompted for the password, enter the password shown in Settings → Root account information. ## Install the Helper Script Once you are connected over SSH, clone the official repository into the location expected by the current script:bash git clone --depth 1 https://github.com/Guilouz/Creality-Helper-Script.git /usr/data/helper-scriptThen start the script:bash sh /usr/data/helper-script/helper.shIf Git has trouble cloning the repository because of SSL verification, the official installation documentation provides this workaround: ```bash git config —global http.sslVerify false
2. If the printer has already been rooted or modified, consider performing the recommended factory reset through SSH.
3. Enable root from **Settings → Root account information**.
4. Find the printer's IP address in the network settings.
5. SSH into the printer using the credentials displayed by the printer.
6. Clone the official Helper Script repository into `/usr/data/helper-script`.
7. Run `helper.sh`.
8. Install the features you actually want, with M600 support and Moonraker + Fluidd/Mainsail being good starting points. The official Helper Script project remains the source of truth for supported printers, firmware requirements, and feature availability.
Comments
One comment per thread every 30 minutes · edits are unlimited.