Skip to main content
Version: 0.7

Installation

1. Install KCL

From the Binary Releases

Each release of KCL includes various OSes and architectures. These binary versions can be manually downloaded and installed from Github and add {install-location} to the environment PATH.

⚠️ If you cannot successfully access Github, you can also access Gitee to obtain binaries for installation.

MacOS & Linux

export PATH=$PATH:{install-location}

Windows

$env:PATH += ";{install-location};"

Using script to install the latest release

MacOS

Install or upgrade the latest darwin KCL to /usr/local/bin

curl -fsSL https://kcl-lang.io/script/install-cli.sh | /bin/bash

Uninstall

curl -fsSL https://kcl-lang.io/script/uninstall-cli.sh | /bin/bash

Linux

Install or upgrade the latest linux KCL to /usr/local/bin

wget -q https://kcl-lang.io/script/install-cli.sh -O - | /bin/bash

Uninstall

wget -q https://kcl-lang.io/script/uninstall-cli.sh -O - | /bin/bash

Windows

Install or upgrade the latest windows KCL to $Env:SystemDrive\kclvm\bin and add this directory to User PATH environment variable.

powershell -Command "iwr -useb https://kcl-lang.io/script/install-cli.ps1 | iex"

Uninstall

powershell -Command "iwr -useb https://kcl-lang.io/script/uninstall-cli.ps1 | iex"

Homebrew (MacOS)

  • Install
# Install the latest version
brew install kcl-lang/tap/kcl@0.7.0

# Specify a version
brew install kcl-lang/tap/kcl@x.y.z
  • Upgrade
brew upgrade kcl-lang/tap/kcl
  • Uninstall
brew uninstall kcl-lang/tap/kcl

Scoop (Windows)

Install Scoop first, then add this bucket and install kcl by running:

scoop bucket add kcl-lang https://github.com/kcl-lang/scoop-bucket.git
scoop install kcl-lang/kcl

From Go

Install kcl through the Go command (Go requires 1.19+).

go install kcl-lang.io/cli/cmd/kcl@latest

From Docker

  • Command
docker run --rm -it kcllang/kcl
  • Update image
docker pull kcllang/kcl

Note

We can execute the following command to ensure that KCL has been installed correctly.

kcl --help

For all the above operating systems and installation methods, if you want to use KCL Python Plugin, you need to ensure that Python 3.7+ is installed and add the python3 command to your PATH environment variable.

If you are unable to successfully install and run KCL, you can refer to here

2. Install KCL IDE Extension

Install Language Server

Before we enable the IDE extension, first we install the KCL Language Server binary and add it to the PATH.

MacOS

Install or upgrade the latest darwin KCL language server to /usr/local/bin

curl -fsSL https://kcl-lang.io/script/install-kcl-lsp.sh | /bin/bash

Linux

Install or upgrade the latest linux KCL language server to /usr/local/bin

wget -q https://kcl-lang.io/script/install-kcl-lsp.sh -O - | /bin/bash

Windows

Install or upgrade the latest windows KCL language server to $Env:SystemDrive\kclvm\bin and add this directory to User PATH environment variable.

powershell -Command "iwr -useb https://kcl-lang.io/script/install-kcl-lsp.ps1 | iex"

Homebrew (MacOS)

  • Install
# Install the latest version
brew install kcl-lang/tap/kcl-lsp@0.7.0

# Specify a version
brew install kcl-lang/tap/kcl-lsp@x.y.z
  • Upgrade
brew upgrade kcl-lang/tap/kcl-lsp
  • Uninstall
brew uninstall kcl-lang/tap/kcl-lsp

Scoop (Windows)

Install Scoop first, then add this bucket and install kcl-language-server by running:

scoop bucket add kcl-lang https://github.com/kcl-lang/scoop-bucket.git
scoop install kcl-lang/kcl-lsp

Install KCL Extensions for IDE

VS Code

The KCL Extension extension provides some coding assistance, e.g., highlight, goto definition, completion, hover, outline, and diagnostics. You can go here for more information about the installation.

Completion

NeoVim

See here to config the KCL language server and enable it.

kcl.nvim

IntelliJ IDEA

Download the distribution from here and in IntelliJ IDEA, click Preference -> plugins -> install Plugin from Disk... -> select kcl-idea-plugin zip -> restart IDE. This plugin requires the IntelliJ IDEA 2020.2+

intellij