Skip to content

Installation

The recommended way to install and manage Kaledis is using Rokit, a toolchain manager for Roblox-related projects.

  1. If you haven’t already, install Rokit.
  2. Add Kaledis to your project:
Terminal window
rokit add orpos/kaledis

This ensures you are using the version of Kaledis specified in your project’s configuration, making collaboration easier.

If you have Rust installed, you can install Kaledis directly from crates.io using Cargo.

Terminal window
cargo install kaledis

This will build and install the latest version of Kaledis to your Cargo bin directory.

You can download pre-built binaries for Windows from the GitHub Releases page.

  1. Download the .zip file for your architecture.
  2. Extract the archive.
  3. Add the extracted folder to your system’s PATH environment variable to use the kaledis command globally.

To build the latest development version from source:

  1. Clone the repository:
    Terminal window
    git clone https://github.com/orpos/kaledis.git
    cd kaledis
  2. Build using Cargo:
    Terminal window
    cargo build --release
  3. The binary will be located in target/release/kaledis.