Liking cljdoc? Tell your friends :D

Building from source

Linux and MacOS

To build the clj-kondo binary from source:

  • Download GraalVM 19 or newer.

  • Set the GRAALVM_HOME variable. E.g.:

      export GRAALVM_HOME=$HOME/Downloads/graalvm-ce-19.2.1/Contents/Home
    
  • git clone this repo and cd clj-kondo

  • Finally:

      script/compile
    

Place the binary somewhere on your path.

Optional steps

These steps are only necessary to update resources that are shipped with clj-kondo.

  • To update the built-in cache for Clojure and ClojureScript:

      script/built-in
    
  • JDK 12 is needed only in this step. To update static method information from commonly used Java classes:

    JAVA_HOME=<path to JDK 12> script/extract-java
    

    where JDK 12 is located in e.g. ~/Downloads/jdk-12.jdk/Contents/Home.

Windows

These steps assume a Windows 10 installation with Git for Windows and leiningen. We will be using the java version that comes with GraalVM, so there is no need to install it separately.

  • Download GraalVM 19 or newer.

  • Install the Windows SDK 7.1. See this link for an explanation which image is which.

    You might first have to:

    • Uninstall any Visual C++ 2010 Redistributables from the control panel. See this SO answer.
    • Tweak these registry settings as a workaround for a message about an incorrect .NET version.

The following steps need to be executed from the Windows SDK 7.1 command prompt.

  • set the GRAALVM_HOME environment variable:

      set GRAALVM_HOME=C:\Users\IEUSer\Downloads\graalvm-ce-19.2.1
    
  • git clone this repo and cd clj-kondo

  • Run script\compile.bat

If the script finished successfully, there is now a clj-kondo.exe in the current directory. Place the binary somewhere on your path.

Can you improve this documentation? These fine people already did:
Michiel Borkent & sogaiu
Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close