KCL Multiple Language Bindings and SDKs

Bindings

Rust

cargo add --git https://github.com/kcl-lang/lib

use kcl_lang::*;
use anyhow::Result;
fn main() -> Result<()> {
 let api = API::default();
 let args = &ExecProgramArgs {
 k_filename_list: vec!["main.k".to_string()],
 k_code_list: vec!["a = 1".to_string()],
 ..Default::default()
 };
 let exec_result = api.exec_program(args)?;
 println!("{}", exec_result.yaml_result);
 Ok(())
}

# Take the kcl-runtime as an example.
cargo add --git https://github.com/kcl-lang/kcl kcl-runtime

Go

go get kcl-lang.io/lib

package main
import (
	"fmt"
	"kcl-lang.io/lib/go/api"
	"kcl-lang.io/lib/go/native"
)
func main() {
	client := native.NewNativeServiceClient()
	result, err := client.ExecProgram(&api.ExecProgramArgs{
		KFilenameList: []string{"main.k"},
		KCodeList: []string{"a = 1"},
	})
	if err != nil {
		t.Fatal(err)
	}
	fmt.Println(result.YamlResult)
}

Java

Maven

<repositories>
 <repository>
 <id>github</id>
 <url>https://maven.pkg.github.com/kcl-lang/*</url>
 <snapshots>
 <enabled>true</enabled>
 </snapshots>
 </repository>
</repositories>

<dependency>
 <groupId>com.kcl</groupId>
 <artifactId>kcl-lib</artifactId>
 <version>0.12.3</version>
</dependency>

import com.kcl.api.API;
import com.kcl.api.Spec.ExecProgramArgs;
import com.kcl.api.Spec.ExecProgramResult;
public class ExecProgramTest {
 public static void main(String[] args) throws Exception {
 API api = new API();
 ExecProgramResult result = api
 .execProgram(ExecProgramArgs.newBuilder().addKFilenameList("path/to/kcl.k").build());
 System.out.println(result.getYamlResult());
 }
}

.NET

dotnet add package KclLib

using KclLib.API;
var api = new API();
var execArgs = new ExecProgramArgs();
var path = Path.Combine("test_data", "schema.k");
execArgs.KFilenameList.Add(path);
var result = api.ExecProgram(execArgs);
Console.WriteLine(result.YamlResult);

Python

python3 -m pip install kcl-lib

import kcl_lib.api as api
args = api.ExecProgramArgs(k_filename_list=["./tests/test_data/schema.k"])
api = api.API()
result = api.exec_program(args)
print(result.yaml_result)

Node.js

npm install kcl-lib

import { execProgram, ExecProgramArgs } from 'kcl-lib'
function main() {
 const result = execProgram(new ExecProgramArgs(['__test__/test_data/schema.k']))
 console.log(result.yamlResult)
}
main();

Kotlin

Maven

<repositories>
 <repository>
 <id>github</id>
 <url>https://maven.pkg.github.com/kcl-lang/*</url>
 <snapshots>
 <enabled>true</enabled>
 </snapshots>
 </repository>
</repositories>

<dependency>
 <groupId>com.kcl</groupId>
 <artifactId>kcl-lib</artifactId>
 <version>0.12.3</version>
</dependency>

import com.kcl.api.API
import com.kcl.api.execProgramArgs
val args = execProgramArgs { kFilenameList += "schema.k" }
val api = API()
val result = api.execProgram(args)

Swift

import KclLib
let api = API()
var execArgs = ExecProgramArgs()
execArgs.kFilenameList.append("schema.k")
let result = try api.execProgram(execArgs)

C++

FetchContent_Declare(
 kcl-lib
 GIT_REPOSITORY https://github.com/kcl-lang/lib.git
 GIT_TAG v0.12.3
 SOURCE_SUBDIR cpp
)
FetchContent_MakeAvailable(kcl-lib)

mkdir third_party
cd third_party
git clone https://github.com/kcl-lang/lib.git

add_subdirectory(third_party/lib/cpp)

target_link_libraries(your_target kcl-lib-cpp)

#include "kcl_lib.hpp"
#include <iostream>
int main()
{
 auto args = kcl_lib::ExecProgramArgs {
 .k_filename_list = { "../test_data/schema.k" },
 };
 auto result = kcl_lib::exec_program(args);
 std::cout << result.yaml_result.c_str() << std::endl;
 return 0;
}

C

WASM

Documents

License