Welcome to the Klipper documentation. If new to Klipper, start with the features and installation documents.

Overview information

  • Features: A high-level list of features in Klipper.
  • FAQ: Frequently asked questions.
  • Releases: The history of Klipper releases.
  • Config changes: Recent software changes that may require users to update their printer config file.
  • Contact: Information on bug reporting and general communication with the Klipper developers.

Configuration and Tuning Guides

Developer Documentation

  • Code overview: Developers should read this first.
  • Kinematics: Technical details on how Klipper implements motion.
  • Protocol: Information on the low-level messaging protocol between host and micro-controller.
  • API Server: Information on Klipper’s command and control API.
  • MCU commands: A description of low-level commands implemented in the micro-controller software.
  • CAN bus protocol: Klipper CAN bus message format.
  • Debugging: Information on how to test and debug Klipper.
  • Benchmarks: Information on the Klipper benchmark method.
  • Contributing: Information on how to submit improvements to Klipper.
  • Packaging: Information on building OS packages.

Device Specific Documents