Kiso는 Open Knowledge Format (OKF) 번들 주위에 건설된 2개의 신청을 제공합니다:

-kiso-cli OKF 번들을 검증하고 생성된 HTML 페이지와 원본 Markdown 파일을 포함하는 정적 웹 사이트로 게시합니다. 명령줄이나 GitHub 동작을 통해 실행할 수 있습니다.

• **kiso-mcp-server**는 MCP 호환 AI 응용 프로그램을 OKF 번들에 포함 된 지식에 액세스 할 수있는 Model Context Protocol (MCP) 서버를 시작합니다.

OKF 번들은 두 응용 프로그램에 대한 진실의 단일 소스를 유지합니다.

실행 가능한 JARs는 Java 25 이상을 요구합니다. Native executables는 Java 설치가 필요하지 않습니다.

키소 CLI

빠른 시작

Kiso를 시험하는 OKF 번들을 필요로 하는 경우에, 당신은 Kiso 웹사이트에서 우리의 표본 OKF 뭉치를 다운로드할 수 있습니다. 다운로드 한 후, unzip it.

릴리스 페이지에서 Kiso의 최신 릴리스를 다운로드 한 다음 실행 :

check] 명령은 OKF 번들에서 Markdown 파일을 검증하고 형식 또는 구조 오류를보고합니다 (그것은 또한 경고로 깨진 링크보고). 번들가 유효하면 정적 웹 사이트를 구축하십시오.

public] 디렉토리에 생성 된 정적 웹 사이트를 찾을 수 있습니다. `index를 열 수 있습니다.

Kiso

Kiso provides two applications built around Open Knowledge Format (OKF) bundles:

• kiso-cli validates an OKF bundle and publishes it as a static website containing generated HTML pages and the original Markdown files. It can be run from the command line or through GitHub Actions.
• kiso-mcp-server starts a Model Context Protocol (MCP) server that lets an MCP-compatible AI application access the knowledge contained in an OKF bundle.

The OKF bundle remains the single source of truth for both applications.

The executable JARs require Java 25 or later. Native executables do not require a Java installation.

Kiso CLI

Quick start

If you need an OKF bundle to test Kiso, you can download our sample OKF bundle from the Kiso website. Once downloaded, unzip it.

Download the latest release of Kiso for your operating system from the releases page, then run:

./kiso-cli check --source=examples/kb-google-example

The check command validates the Markdown files in the OKF bundle and reports formatting or structural errors (it also reports broken links as warnings). Once the bundle is valid, build the static website:

./kiso-cli build --source=examples/kb-google-example --destination=public

You will find the generated static website in the public directory. You can open the index.html file in your browser to view the generated site.

If you use the native Kiso binary and want Kiso to generate social network preview images, install one of the supported native SVG to PNG conversion tools: rsvg-convert, inkscape, or resvg.

GitHub Actions

You can use Kiso CLI in GitHub Action to automatically build your OKF bundles into static websites whenever you push changes to your repository. Here’s an example workflow configuration:

- name: Build with Kiso
  uses: oak-invest/kiso/applications/[email protected]
  with:
    command: build
    source: examples/kb-google-example
    destination: website/examples/kb-google-example-latest

Commands

Options

| Variable | Command | Default | Description |