Kiso предоставляет два приложения, построенные на основе Open Knowledge Format (OKF):

kiso-cli проверяет пакет OKF и публикует его как статический веб-сайт, содержащий генерируемые HTML-страницы и исходные файлы Markdown. Он может быть запущен из командной строки или через GitHub Actions. kiso-mcp-server Запускает сервер Model Context Protocol (MCP), который позволяет MCP-совместимому приложению ИИ получить доступ к знаниям, содержащимся в пакете OKF.

Пакет OKF остается единственным источником истины для обоих приложений.

Для выполнения JAR требуется Java 25 или более поздней версии. Нативные исполняемые файлы не требуют установки Java.

# Kiso CLI

###Быстрый старт

Если вам нужен пакет OKF для тестирования Kiso, вы можете загрузить наш образец пакета OKF с веб-сайта Kiso. После загрузки разблокируйте его.

Загрузите последнюю версию Kiso для вашей операционной системы со страницы релизов, а затем запустите:

Команда check проверяет файлы Markdown в пакете OKF и сообщает о форматировании или структурных ошибках (она также сообщает о неработающих ссылках в качестве предупреждений). Как только пакет будет действителен, создайте статический веб-сайт:

Вы найдете созданный статический веб-сайт в каталоге public. Вы можете открыть индекс.

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 |