KAIVM - Shinkai 版本管理器

KAIVM 是一个跨平台命令行界面 (CLI)，旨在简化下载、管理、配置和运行不同版本的 Shinkai Node 的过程。它提供了一种无缝切换 Shinkai Node 版本的方法，确保开发者可以轻松地对多个版本进行应用程序测试。有关 Shinkai Node 入门的更多信息，请访问 Shinkai 文档。

入门

使用 KAIVM 入门非常简单。

按照以下步骤安装、运行和自定义特定的 Shinkai Node 版本

1. 安装 KAIVM

安装 KAIVM 有两种主要方法

选项 1：使用 Cargo 安装

如果您已安装 Rust 的包管理器 Cargo，您可以通过运行以下命令轻松添加 KAIVM：

cargo install kaivm

选项 2：使用二进制文件安装

对于 macOS Apple Silicon 用户，安装过程涉及几个简单的步骤。请按照以下说明操作

curl -L https://raw.githubusercontent.com/agallardol/kaivm/main/temp-release/kaivm-aarch64-apple-darwin -o kaivm
chmod +x kaivm
mv kaivm /usr/local/bin/

对于其他平台上的用户，安装说明即将推出。

2. 安装和运行 Shinkai Node

1. 安装 Shinkai Node 版本

   要安装特定版本的 Shinkai Node，请使用 install 命令后跟版本号。例如，要安装版本 0.5.3，您将运行

   kaivm install v0.5.3
   

2. 运行 Shinkai Node

   安装所需的版本后，您可以使用 kaivm node run 命令运行它。这将启动 Shinkai Node，并使用当前设置的版本

   kaivm node run
   

3. 自定义 Shinkai Node

   您可以通过使用 --var=value 语法传递环境变量来自定义 Shinkai Node 实例。例如，要设置 API 端口和存储路径，您可以使用

   kaivm node env --node_api_port=9550 --node_storage_path=~/.kaivm/data
   

按照这些步骤，您可以轻松管理、在不同版本之间切换，并自定义 Shinkai Node 以满足您的开发需求。

配置和资产

KAIVM 将其配置文件和下载的 Shinkai Node 版本存储在 ~/.kaivm 目录中。这种集中式存储使其易于管理和访问所有 KAIVM 相关资产。

可用命令

KAIVM 提供了各种命令来管理 Shinkai Node 版本

• list：列出所有已安装的 Shinkai Node 版本。

  kaivm list
  

• 安装：下载并安装特定版本的Shinkai Node。

  kaivm install 1.2.3
  

• 使用：将特定版本的Shinkai Node设置为当前版本。

  kaivm use 1.2.3
  

• 版本：显示当前Shinkai Node版本。

  kaivm version
  

• node run：运行当前设置的Shinkai Node版本。

  kaivm node run
  

• node reset：重置Shinkai Node。

  kaivm node reset
  

• node env：为当前Shinkai Node会话设置环境变量。可用选项包括

  • --node_api_port：指定Shinkai Node API运行的端口号。
  • --node_storage_path：定义Shinkai Node存储数据的文件系统路径。
  • --unstructured_server_url：Shinkai Node将与之通信的非结构化服务器的URL。
  • --embeddings_server_url：Shinkai Node用于处理数据的嵌入服务器的URL。
  • --first_device_needs_registration_code：确定连接到Shinkai Node的第一个设备是否需要注册码进行认证。接受'true'或'false'。
  • --initial_agent_names：用逗号分隔的初始代理名称列表，将被注册到Shinkai Node。
  • --initial_agent_urls：用逗号分隔的初始代理的URL列表，对应于提供的名称。
  • --initial_agent_models：用逗号分隔的初始代理的模型列表，对应于提供的名称。
  • --initial_agent_api_keys：用逗号分隔的初始代理的API键列表，对应于提供的名称。
  • --starting_num_qr_devices：Shinkai Node应支持的初始QR设备数量。
  • --node_port：指定Shinkai Node运行的端口号。
  • --node_ws_port：指定Shinkai Node的WebSocket端口。
  • --unstructured_server_api_key：Shinkai Node将与之通信的非结构化服务器的API键。
  • --embeddings_server_api_key：Shinkai Node用于处理数据的嵌入服务器的API键。
  • --job_manager_threads：Shinkai Node作业管理器内使用的线程数。
  • --global_identity_name：Shinkai Node的全局身份名称。

  kaivm node env --node_api_port 9550 --node_storage_path ~/.kaivm/data
  

使用KAIVM，管理Shinkai Node版本变得轻而易举，使开发者能够专注于构建和测试他们的应用程序。