Skip to content

Installing cldk#

CLDK is a Python SDK hosted on PyPI and can be installed using your preferred Python package manager.

Installation#

The Python SDK can be installed directly from PyPI using any Python package manager such as pip, poetry, or uv:

pip install cldk

poetry add cldk

uv add cldk

Programming Language Specific Dependencies#

CLDK supports program analysis for multiple languages and requires additional dependencies to support specific languages. The following table lists the additional dependencies required for each language:

For Python analysis as well as to use the CLDK Python SDK, you will need to install the Python programming language with version 3.11 or later. We recommend using a package manager like pyenv to install and manage Python dependencies.

For Java analysis, CLDK relies on a companion project called codeanalyzer. codeanalyzer is a java project and you will therefore need to install the Java Development Kit (JDK) with java version 11 or later.

You can use a package manager like SDKMAN to install the JDK. First, install SDKMAN by running the following command:

  • To install SDKMan, open your terminal and enter the following command and follow the instructions to complete the installation:

    curl -s "https://get.sdkman.io" | bash

  • Open a new terminal or source the SDKMan! scripts:

    source "$HOME/.sdkman/bin/sdkman-init.sh"

Next, install java 11 or later using SDKMAN:

  • You can list all available java versions with:

    sdk list java | grep sem

    You should see something like this: 

    Semeru      |     | 21.0.5       | sem     |            | 21.0.5-sem
            |     | 17.0.13      | sem     |            | 17.0.13-sem
            |     | 11.0.25      | sem     |            | 11.0.25-sem
            |     | 8.0.432      | sem     |            | 8.0.432-sem

  • Install Java 11 or above (we'll go with 11.0.25-sem):

    sdk install java 11.0.25-sem

  • Set Java 11 as the current (or default) Java version:

    sdk use java 11.0.25-sem
# If want to default to java 11 for all sessions, use the following command instead:
# sdk default java 11.0.25-sem

  • Verify the installation:

    java -version

    This should output the version of the installed Java.

    openjdk 11.0.25 2024-10-15
IBM Semeru Runtime Open Edition 11.0.25.0 (build 11.0.25+9)
Eclipse OpenJ9 VM 11.0.25.0 (build openj9-0.48.0, JRE 11 Linux amd64-64-Bit Compressed References 20241107_1233 (JIT enabled, AOT enabled)
OpenJ9   - 1d5831436e
OMR      - d10a4d553
JCL      - edded3f65c based on jdk-11.0.25+9)

Finally, to enable building Java projects automatically, you will need to install the maven build tool. You can install maven using a package manager like SDKMAN:

  • Install Maven:

    sdk install maven

  • Make sure mvn command is available in the PATH. If mvn is not in your path, add the following to your ~/.zshrc, ~/.bashrc or ~/.bash_profile file:

    export PATH="$HOME/.sdkman/candidates/maven/current/bin:$PATH"
    Then, source the file to apply the changes:

    source ~/.zshrc # or ~/.bashrc or ~/.bash_profile

  • Verify the installation:

    mvn -version
    This should output the version of the installed Maven.

CLDK uses LLVM and Clang Python bindings to analyze C/C++ code. The project requires specific versions:

  • libclang >= 18.1.1
  • clang >= 17.0.6

You can install LLVM and Clang using various package managers depending on your operating system.

  • Install LLVM 18 using Homebrew 

    brew install llvm@18

  • Add LLVM to your PATH (add this to your ~/.zshrc or ~/.bash_profile) 

    export PATH="/usr/local/opt/llvm@18/bin:$PATH"
export LDFLAGS="-L/usr/local/opt/llvm@18/lib"
export CPPFLAGS="-I/usr/local/opt/llvm@18/include"

  • Verify installation 

    clang --version
    This should output the version of the installed LLVM and Clang. 
    Apple clang version 18.1.1
Target: x86_64-apple-darwin21.6.0
Thread model: posix
InstalledDir: /usr/local/opt/llvm@18/bin

  • Add LLVM repository and install required packages 

    wget https://apt.llvm.org/llvm.sh
chmod +x llvm.sh
sudo ./llvm.sh 18
sudo apt-get install llvm-18 llvm-18-dev clang-18 libclang-18-dev

  • Create symlinks (optional but recommended) 

    sudo ln -s /usr/bin/clang-18 /usr/bin/clang
sudo ln -s /usr/bin/llvm-config-18 /usr/bin/llvm-config

  • Verify installation 

    clang --version
    This should output the version of the installed LLVM and Clang. 
    Ubuntu clang version 18.1.1
Target: x86_64-pc-linux-gnu
Thread model: posix
InstalledDir: /usr/bin

  • Install LLVM 18 and development packages 

    # On Fedora
sudo dnf install llvm18 llvm18-devel clang18 clang18-devel

# On CentOS/RHEL (if needed)
sudo yum install epel-release
sudo yum install llvm18 llvm18-devel clang18 clang18-devel

  • Create symlinks (optional but recommended) 

    sudo ln -s /usr/bin/clang-18 /usr/bin/clang
sudo ln -s /usr/bin/llvm-config-18 /usr/bin/llvm-config

  • Verify installation 

    clang --version
    This should output the version of the installed LLVM and Clang. 
    clang version 18.1.8 (Fedora 18.1.8-5.fc41)
Target: x86_64-redhat-linux-gnu
Thread model: posix
InstalledDir: /usr/bin
Configuration file: /etc/clang18/x86_64-redhat-linux-gnu-clang.cfg

Rustup is the recommended tool for installing Rust and managing its toolchains. It simplifies the process of keeping Rust up to date and allows switching between different Rust versions and toolchains seamlessly.

  • Install Rustup Run the following command in your terminal: 

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
    Follow the on-screen instructions to complete the installation.

  • Configure Your Environment Add Rust to your PATH by appending this line to your shell init script: 

    source $HOME/.cargo/env

  • Verify Installation Confirm that Rust is installed correctly by checking the version: 

    rustc --version
    Expected output (version may vary): 
    rustc 1.70.0 (90c541806 2023-05-31)

Additional Development Tools#

Some operating systems may require additional development tools:

  • Make sure you have the Xcode Command Line Tools installed. You can install them using the following command:

    xcode-select --install

  • Additionally, you may need to install the following packages using Homebrew:

    brew install openssl readline sqlite3 xz zlib tcl-tk libffi

  • Install the required development tools using the following command:

    sudo apt-get install build-essential python3-dev libssl-dev zlib1g-dev \
libbz2-dev libreadline-dev libsqlite3-dev curl git \
libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev

  • Install the required development tools using the following command:

    sudo dnf group install c-development development-tools gcc make \
patch zlib-devel bzip2 bzip2-devel readline-devel sqlite sqlite-devel\
openssl-devel tk-devel libffi-devel xz-devel

Supported Python Versions#

CLDK is compatible with Python versions 3.11 and later. The following table lists the supported Python versions and the corresponding CLDK versions:

Python Version Compatible cldk Versions
3.11 ≥0.4.0