跳到主要内容

CLI Reference

根命令:

mushroom-agent <command> [options]

可用命令:

命令说明
init初始化本地配置、prompts 和 sidecar 文件
start启动本地 agent、配置化设备 runtime 和浏览器 UI
serve启动 agent 服务与 API 通信入口
node连接远端服务与运行硬件诊断
admin管理 skills 和 tools

mushroom-agent init

~/.mushroom_agent/ 下初始化本地环境。命令会启动交互式引导,把文字模式或语音模式所需的模型配置写入 config.yaml

mushroom-agent init
mushroom-agent init --root /custom/path
mushroom-agent init --force

默认生成:

config.yaml
hardware.yaml
remote.yaml
logs/
skills/
prompts/
SOUL.md
AGENTS.md
IDENTITY.md

生成的 config.yaml starter 只写入 workspace.path 作为本地路径锚点。日志、默认 skills/ 目录、memory 存储,以及 read / exec / write 的工作目录都会在运行时从该路径派生。hardware.yaml 用于 startnode attach 的本地设备输入/输出配置;remote.yaml 用于 node attach 的远端 agent 接入配置。

选项:

选项说明
--root指定本地环境根目录(默认:~/.mushroom_agent
--force覆盖已有生成文件

mushroom-agent start

在同一进程内启动配置化本地 agent 和设备 runtime。浏览器 UI 默认启用;命令会打印 URL,并在服务就绪后自动打开浏览器。

export MUSHROOM_SKIP_LANGFUSE_AUTH=1
mushroom-agent start
mushroom-agent start --host 127.0.0.1 --port 7860

选项:

选项说明
--config指定配置文件路径
--hostUI server host(默认读取 server.host
--portUI server port(默认读取 server.port

本地 UI 包含 Local I/O 视图,可查看配置化音频、文本、视频输入,User/Agent 语音文本,最新视频帧,命令摘要和硬件输出事件。

mushroom-agent serve

config.yaml 启动 agent 服务。这个命令是 HTTP chat、WebSocket chat、实时语音和函数通信的服务入口。

export MUSHROOM_SKIP_LANGFUSE_AUTH=1
mushroom-agent serve

选项:

选项说明
--config指定配置文件路径
--communications逗号分隔的通信方式:httpwebsocketfunc
--portHTTP 端口(默认:7860

浏览器测试页

本地浏览器测试使用 --ui。它会挂载 /i/chat、打印 URL,并默认自动打开浏览器。

mushroom-agent serve --ui
选项说明
--ui/i/chat 挂载本地浏览器测试页

mushroom-agent node

将配置化设备 runtime 接入远端服务,或运行本地硬件诊断。本地进程内启动由 mushroom-agent start 负责。

node attach

将本设备 runtime 接入 remote.yaml 中配置的远端 agent 服务。

# 1. 在 agent 主机上
mushroom-agent serve

# 2. 在每台设备上
mushroom-agent node attach

选项:

选项说明
--config指定本地配置文件路径,并使用同目录下的 remote.yaml

node record-audio

采集本地音频,用于降噪 A/B 诊断。

mushroom-agent node record-audio --seconds 10

选项:

选项说明
--seconds录音时长,单位秒
--config指定配置文件路径

mushroom-agent skills

管理已安装的 skills。

mushroom-agent skills list
mushroom-agent skills available
mushroom-agent skills install <name>
mushroom-agent skills install --source <repo-or-dir> --all

mushroom-agent admin

高级管理命令。

mushroom-agent admin tools list

Local vs Remote

serve --ui

启动服务/API 路径并挂载 /i/chat。

start

Agent 与配置化设备 runtime 在一个进程内运行,并打开本地 UI。

serve + node attach

在主机上启动 agent,再将一台或多台配置化设备接入它。