Skip to main content

Common Commands

Documentation Note

This document compiles commonly used Linux commands within the Klipper system, primarily for:

  • Daily Operation Reference – Provides quick lookup for frequently used commands.
  • Troubleshooting Assistance – Allows finding relevant commands for verification or repair when encountering common issues.
  • Learning & Reference – Serves as a basic command set for interacting with Linux and Klipper.

Note: This document only lists commands with brief explanations and does not cover specific debugging procedures or fault analysis. Please use it in conjunction with specific scenarios.

Device Identification​

CAN Device ID Query​

Standard Host:

~/klippy-env/bin/python ~/klipper/scripts/canbus_query.py can0

FLY Host:

python3 ~/klipper/scripts/canbus_query.py can0

USB Device ID Query​

ls /dev/serial/by-id/*

Firmware Flashing​

STM32 Series (DFU Mode)​

  • Note: HEX files cannot be flashed.
sudo dfu-util -a 0 -d 0483:df11 --dfuse-address 0x08000000 -D ~/<firmware_file>.bin

Flashing Klipper via Katapult​

USB Connection​

Standard Host:

~/klippy-env/bin/python ~/katapult/scripts/flashtool.py -d /dev/serial/by-id/<your_board_id>

FLY Host:

python ~/katapult/scripts/flashtool.py -d /dev/serial/by-id/<your_board_id>

Universal Command (requires specifying device ID):

cd ~/klipper/ && make flash FLASH_DEVICE=<your_board_id>

CAN Reset to Bootloader​

Standard Host:

~/klippy-env/bin/python3 ~/katapult/scripts/flashtool.py -i can0 -r -u <your_board_id>

FLY Host:

python3 ~/katapult/scripts/flashtool.py -i can0 -r -u <your_board_id>

RP2040 Series​

Flashing Klipper Firmware​

cd ~/klipper/ && make flash FLASH_DEVICE=2e8a:0003

Flashing Bootloader​

First-time flashing requires building the tool:

cd ~/klipper/ && cd ~/klipper/lib/rp2040_flash/ && make

Execute flashing:

sudo ~/klipper/lib/rp2040_flash/rp2040_flash ~/<firmware_path>/<filename>.uf2

Code Management​

Pulling a Specific Branch​

Pull the dev-flyos branch of the repository to the /data/klipper directory:

cd && git clone https://cnb.cool/3dmellow/public/klipper -b dev-flyos /data/klipper

Service Management​

Klipper Service​

Restart Service​

sudo systemctl restart klipper

View Real-time Logs​

sudo journalctl -u klipper -f

Check Service Status​

sudo systemctl status klipper

Moonraker Service​

Restart Service​

sudo systemctl restart moonraker

View Real-time Logs​

sudo journalctl -u moonraker -f

Check Service Status​

sudo systemctl status moonraker

KlipperScreen Service​

Restart Service​

sudo systemctl restart KlipperScreen

View Real-time Logs​

sudo journalctl -u KlipperScreen -f

Check Service Status​

sudo systemctl status KlipperScreen
Loading...