Skip to content

Latest commit

 

History

History
103 lines (61 loc) · 3.27 KB

install.md

File metadata and controls

103 lines (61 loc) · 3.27 KB

Installation

Manual install

Pre-built binaries are available for linux, macOS and Windows on the releases page.

Installation script (macOS and Linux)

This installation script works for linux and MacOS and can be used for quickly installing or upgrading to the newest clj-kondo without a package manager. It will install to /usr/local/bin by default.

To download and execute the script:

curl -sLO https://raw.githubusercontent.com/clj-kondo/clj-kondo/master/script/install-clj-kondo
chmod +x install-clj-kondo
./install-clj-kondo

To install to a different directory, append the option --dir <dir> to the above command. To download to a different directory, append the option --download-dir <dir>. To install a specific version, use --version <yyyy.mm.dd>.

To upgrade, just run the script again.

Linux packages

Repositories for various Linux distributions can be found here. Look here for Arch and here for NixOS.

Arch

clj-kondo is available in the Arch User Repository. It can be installed using your favorite AUR helper such as yay or paru. Here is an example using yay:

yay -S clj-kondo-bin

NixOS

clj-kondo is available in the Nix Packages collection. To install it globally, add it to your systemPackages. If you just want to try it, you can do it in a Nix shell:

nix-shell -p clj-kondo

Brew (MacOS and Linux)

On MacOS you can use brew. On Linux you can use Homebrew on Linux.

To install with brew:

brew install borkdude/brew/clj-kondo

To upgrade:

brew upgrade clj-kondo

Scoop (Windows)

A Windows binary version of clj-kondo.exe is available via this scoop bucket which also has several other Clojure tools for Windows:

scoop bucket add scoop-clojure https://github.com/littleli/scoop-clojure
scoop install clj-kondo

To update:

scoop update clj-kondo

ASDF

clj-kondo can be installed with ASDF plugin.

To add clj-kondo plugin:

asdf plugin add clj-kondo https://github.com/rynkowsg/asdf-clj-kondo.git

To list available versions:

asdf list-all clj-kondo

To install locally within a project:

asdf install clj-kondo <yyyy.mm.dd>
asdf local clj-kondo <yyyy.mm.dd>

Alternatively, you can set a global version:

asdf global clj-kondo <yyyy.mm.dd>