README.md

KCL CLI

English | 简体中文

Introduction | Installation | Quick start

Introduction

kcl is a command-line interface that includes language core features, IDE features, package management tools, community integration, and other tools. It now integrates the following tools:

• KCL Go SDK
• Open API Tool
• Package Manage Tool
• KCL Playground

In the future, we will unify and integrate these dispersed tools into the kcl-lang/tools repo.

Installation

Scripts

MacOS

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

Linux

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

Windows

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

Homebrew (MacOS & Linux)

brew install kcl-lang/tap/kcl

Scoop (Windows)

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

Go install

You can download kcl via go install.

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

Download from GITHUB Release Page

You can also get kcl from the github release and set the binary path to the environment variable PATH.

# KCL_CLI_INSTALLATION_PATH is the path of the `KCL CLI` binary.
export PATH=$KCL_CLI_INSTALLATION_PATH:$PATH  

Docker

docker run -it kcllang/kcl

Docker for arm64

docker run -it kcllang/kcl-arm64

Build from Source Code

git clone https://github.com/kcl-lang/cli
cd cli && go build ./cmd/kcl/main.go -o kcl

Use the following command to ensure that you install kcl successfully.

kcl --help

Quick Start

kcl run ./examples/kubernetes.k

Learn More

• KCL Website

License