-
Notifications
You must be signed in to change notification settings - Fork 119
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
153 additions
and
131 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
<h1 align="center">KCLVM</h1> | ||
|
||
<p align="center"> | ||
<a href="./README.md">English</a> | <a href="./README-zh.md">简体中文</a> | ||
</p> | ||
<p align="center"> | ||
<a href="#介绍">介绍</a> | <a href="#特性">特性</a> | <a href="#场景">场景</a> | <a href="#安装">安装</a> | <a href="#快速开始">快速开始</a> | <a href="#文档">文档</a> | <a href="#贡献">贡献</a> | <a href="#路线规划">路线规划</a> | <a href="#许可">许可</a> | ||
</p> | ||
|
||
<p align="center"> | ||
<img src="https://img.shields.io/github/release/KusionStack/KCLVM.svg"> | ||
<img src="https://img.shields.io/badge/Rust-1.60-blue.svg"> | ||
<img src="https://coveralls.io/repos/github/KusionStack/KCLVM/badge.svg"> | ||
<img src="https://img.shields.io/github/license/KusionStack/KCLVM.svg"> | ||
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square"> | ||
</p> | ||
|
||
<p align="center"> | ||
<img src="https://github.com/KusionStack/KCLVM/actions/workflows/ubuntu_test.yaml/badge.svg"> | ||
<img src="https://github.com/KusionStack/KCLVM/actions/workflows/macos_test.yaml/badge.svg"> | ||
<img src="https://github.com/KusionStack/KCLVM/actions/workflows/windows_test.yaml/badge.svg"> | ||
</p> | ||
|
||
## 介绍 | ||
|
||
Kusion 配置语言(KCL)是一个开源的基于约束的记录及函数语言。KCL 通过成熟的编程语言理论和实践来改进对大量繁杂的配置数据和逻辑的编写,通过声明式的语法结合静态类型等技术特性来简化和校验配置的开发和运维工作。 | ||
|
||
## 特性 | ||
|
||
+ **设计优良**:独立设计的语法、语义、运行时和系统库,提供[配置(config)](https://kusionstack.io/docs/reference/lang/lang/codelab/simple)、[类型(schema)](https://kusionstack.io/docs/reference/lang/lang/tour/#schema)、[函数(lambda)](https://kusionstack.io/docs/reference/lang/lang/tour/#%E5%87%BD%E6%95%B0)、[规则(rule)](https://kusionstack.io/docs/reference/lang/lang/tour/#rule)等核心语言元素 | ||
+ **建模能力**:以 [Schema](https://kusionstack.io/docs/reference/lang/lang/tour#schema) 为中心的建模抽象 | ||
+ **使用简单**:语言自身覆盖大多数配置和策略功能 | ||
+ **可靠**:[静态类型系统](https://kusionstack.io/docs/reference/lang/lang/tour#%E7%B1%BB%E5%9E%8B%E7%B3%BB%E7%BB%9F)和[自定义 Rule 规则约束](https://kusionstack.io/docs/reference/lang/lang/tour#rule) | ||
+ **可扩展**:配置分块定义能力及丰富的[配置合并覆盖能力](https://kusionstack.io/docs/reference/lang/lang/tour#%E9%85%8D%E7%BD%AE%E6%93%8D%E4%BD%9C) | ||
+ **自动化能力**:丰富的[语言级 CRUD APIs](https://kusionstack.io/docs/reference/lang/lang/tour#kcl-%E5%8F%98%E9%87%8F%E4%BF%AE%E6%94%B9) 和[多语言 APIs](https://kusionstack.io/docs/reference/lang/xlang-api/overview) | ||
+ **高性能**:语言编译器本身主要采用 Rust & C 实现,配合 [LLVM](https://llvm.org/) 优化器,支持编译到本地代码和 [WASM](https://webassembly.org/https://webassembly.org/) 等目标并高效执行 | ||
+ **云原生亲和**:原生支持 [OpenAPI](https://github.com/KusionStack/kcl-openapi) 和 Kubernetes CRD Specs 到 KCL 的转换,支持 Kubernetes YAML 规范 | ||
+ **开发友好**:丰富的[语言工具](https://kusionstack.io/docs/reference/cli/kcl/) (Format,Lint,Test,Vet,Doc 等)、 [IDE 插件](https://github.com/KusionStack/vscode-kcl)和[语言插件](https://github.com/KusionStack/kcl-plugin) | ||
|
||
## 场景 | ||
|
||
您可以将 KCL 用于 | ||
|
||
+ 生成低级配置数据如 JSON, YAML 等 | ||
+ 使用 schema 对配置数据进行建模并减少配置数据中的样板文件 | ||
+ 为配置数据定义带有规则约束的 schema 并对数据进行自动验证 | ||
+ 分块编写配置数据并使用不同的策略合并数据 | ||
+ 无副作用地组织、简化、统一和管理庞大的配置 | ||
+ 与 [Kusion Stack](https://kusionstack.io) 一起,定义您的应用交付运维生态 | ||
|
||
## 安装 | ||
|
||
从 Github releases 页面[下载](https://github.com/KusionStack/KCLVM/releases),并且将 `{install-location}/kclvm/bin` 添加到您的环境变量中 | ||
|
||
## 快速开始 | ||
|
||
`./samples/fib.k` 是一个计算斐波那契数列的例子 | ||
|
||
```kcl | ||
schema Fib: | ||
n1: int = n - 1 | ||
n2: int = n1 - 1 | ||
n: int | ||
value: int | ||
if n <= 1: | ||
value = 1 | ||
elif n == 2: | ||
value = 1 | ||
else: | ||
value = Fib {n: n1}.value + Fib {n: n2}.value | ||
fib8 = Fib {n: 8}.value | ||
``` | ||
|
||
我们可以通过执行如下命令得到 YAML 输出 | ||
|
||
``` | ||
kcl ./samples/fib.k | ||
``` | ||
|
||
YAML 输出 | ||
|
||
```yaml | ||
fib8: 21 | ||
``` | ||
## 文档 | ||
更多文档请访问 https://kusionstack.io | ||
## 贡献 | ||
参考[开发手册](./docs/dev_guide/1.about_this_guide.md). | ||
## 路线规划 | ||
参考[KCLVM 路线规划](https://kusionstack.io/docs/governance/intro/roadmap#kclvm-%E8%B7%AF%E7%BA%BF%E8%A7%84%E5%88%92) | ||
## 许可 | ||
[Apache License Version 2.0](./LICENSE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.