Kiso は Open Knowledge Format (OKF) バンドルの周りに構築された 2 つのアプリケーションを提供しています。

-[kiso-cli OKFバンドルを検証し、生成されたHTMLページと元のMarkdownファイルを含む静的Webサイトとして公開します。 コマンドラインや GitHub Actions から実行できます。 -[kiso-mcp-server MCP対応AIアプリケーションがOKFバンドルに含まれる知識にアクセスできるように、モデルコンテキストプロトコル(MCP)サーバーを開始します。

OKF バンドルは、両方のアプリケーションのための真理の単一ソースのままです。

実行可能なJARはJava 25以降が必要です。 ネイティブ実行可能はJavaのインストールを必要としません。

キソクリ

クイックスタート

KisoをテストするためにOKFバンドルが必要な場合は、KisoのウェブサイトからサンプルOKFバンドルをダウンロードできます。 ダウンロードしたら、解凍します。

リリースページからお使いのオペレーティングシステム用の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 |