跳到主要内容

Getting Started

按以下步骤，几分钟内在本地把 MushroomAgent 跑起来。这是目前从安装到可工作的本地 agent 的最短支持路径。

第一次使用时，先按 agent 模式安装。agent 是决策端：它接收信息、调用模型、决定要执行什么 action，并且可以在一台机器上单独运行。

你需要什么​

  • Linux 或 macOS。Windows 用户请先使用 WSL2。
  • 正常的交互式终端
  • 可用的 LLM API Key

快速安装​

  1. 运行安装脚本

    curl -fsSL https://docs.kiwilightyear.com/install.sh | bash

    安装脚本会检查系统、尽量安装缺失依赖、下载 MushroomAgent、链接 mushroom-agent 命令，并启动初始化向导。

  2. 按提示完成配置

    本地安装选择默认的 agent 模式，然后按向导提示填写服务商、模型和 API key。

  3. 启动 agent

    mushroom-agent start

Node 模式​

Node 模式用于单独的设备：这个设备负责为另一个已经运行的 agent 收集输入并执行输出。

node 会收集语音、视频、文本、本地设备事件等信息，然后转发给 agent。agent 根据信息做决策，再把要执行的 action 发回 node。action 可能是语音输出、界面操作、机器人动作，或其他设备特有能力。

只有在已有 agent 正在运行，并且已经有 node access key 时，才使用独立的 node 安装脚本：

curl -fsSL https://docs.kiwilightyear.com/install_node.sh | bash -s -- \
  --server-url ws://server-host:7860 \
  --access-key <accesskey> \
  --node-name "Kitchen Pi"

然后启动 node：

mushroom-agent node attach

语音模式​

语音相关配置可由安装脚本里的初始化向导生成。按提示选择语音模式，然后正常启动：

mushroom-agent start

下一步​

文档导航

按主题浏览全部文档。

CLI 参考

了解 remote 模式和多设备接入方式。