livekit-cli

LiveKit CLI

LiveKit CLI（lk）提供命令行工具，用于管理 LiveKit Cloud 项目、根据模板创建应用、部署 Agent，以及配置电话服务。

LiveKit MCP 服务工具

此技能与 LiveKit MCP 服务配合使用，该服务可直接访问最新的 LiveKit 文档、代码示例和更新日志。当你需要了解可能在创建此技能后有所变更的最新信息时，请使用这些工具。

可用的 MCP 工具：

• docs_search - 搜索 LiveKit 文档站点
• get_pages - 按路径获取特定文档页面
• get_changelog - 获取 LiveKit 软件包的最新版本和更新
• code_search - 在 LiveKit 代码库中搜索代码示例
• get_python_agent_example - 浏览 100 多个 Python Agent 示例

何时使用 MCP 工具：

• 你需要最新的 API 文档或功能更新
• 你正在寻找近期示例或代码模式
• 你想确认某项功能是否已在近期版本中添加
• 本地参考资料未涵盖某个特定主题

何时使用本地参考资料：

• 你需要快速查阅此技能涵盖的核心概念
• 你正在离线工作，或希望更快地查阅常见模式
• 参考资料中的信息足以满足你的需求

结合使用 MCP 工具和本地参考资料，获得最佳体验。

参考资料

根据需要查阅以下资源：

• ./references/livekit-overview.md -- LiveKit 生态系统概览
• ./references/project-commands.md -- 项目管理和令牌生成
• ./references/agent-commands.md -- Agent 部署和管理
• ./references/telephony-commands.md -- 电话号码和 SIP 配置

安装

macOS（Homebrew）：

brew install livekit-cli

Linux：

curl -sSL https://get.livekit.io/cli | bash

Windows（winget）：

winget install LiveKit.LiveKitCLI

定期更新 CLI，以获取最新功能：

# macOS
brew update && brew upgrade livekit-cli

# Linux
curl -sSL https://get.livekit.io/cli | bash

# Windows
winget upgrade LiveKit.LiveKitCLI

身份验证

将 LiveKit Cloud 项目关联到 CLI：

lk cloud auth

这会打开浏览器窗口，让你登录 LiveKit Cloud 并选择项目。CLI 会在本地存储你的凭据，并为你的 CLI 实例生成 API 密钥。

撤销授权：

lk cloud auth --revoke

项目管理

列出所有已配置的项目（默认项目以 * 标记）：

lk project list

将其他项目设为默认项目：

lk project set-default <project-name>

手动添加可自托管项目：

lk project add my-project \
  --url http://localhost:7880 \
  --api-key <my-api-key> \
  --api-secret <my-api-secret> \
  --default

从 CLI 中移除项目：

lk project remove <project-name>

环境变量

将 LiveKit Cloud 凭据载入 .env.local 文件：

lk app env -w

这会将 LIVEKIT_URL、LIVEKIT_API_KEY 和 LIVEKIT_API_SECRET 写入本地环境文件。

根据模板创建应用

根据模板初始化新应用：

lk app create --template <template_name> my-app

不使用 --template 运行，即可查看所有可用模板：

lk app create

可用模板：

模板	描述
agent-starter-python	Python 语音 Agent 入门模板
agent-starter-react	Next.js 语音 AI 前端
agent-starter-android	Android 语音 AI 应用
agent-starter-swift	Swift 语音 AI 应用
agent-starter-flutter	Flutter 语音 AI 应用
agent-starter-react-native	React Native/Expo 语音 AI 应用
agent-starter-embed	可嵌入的语音 AI 小组件
token-server	Node.js 令牌服务
meet	视频会议应用
multi-agent-python	多 Agent 工作流示例
outbound-caller-python	外呼 Agent

注意： 模板可能会随时间更新。不带参数运行 lk app create，即可交互式查看当前列表。

生成访问令牌

创建用于加入房间的访问令牌：

# For LiveKit Cloud
lk token create \
  --api-key <PROJECT_KEY> --api-secret <PROJECT_SECRET> \
  --join --room test_room --identity test_user \
  --valid-for 24h

# For local development (dev mode)
lk token create \
  --api-key devkey --api-secret secret \
  --join --room test_room --identity test_user \
  --valid-for 24h

使用模拟参与者进行测试

以模拟参与者身份加入房间，并使用演示视频：

# For LiveKit Cloud
lk room join \
  --url <PROJECT_SECURE_WEBSOCKET_ADDRESS> \
  --api-key <PROJECT_API_KEY> --api-secret <PROJECT_SECRET_KEY> \
  --publish-demo --identity bot_user \
  my_first_room

# For local development
lk room join \
  --url ws://localhost:7880 \
  --api-key devkey --api-secret secret \
  --publish-demo --identity bot_user \
  my_first_room

部署 Agent

将你的第一个 Agent 部署到 LiveKit Cloud：

cd your-agent-project
lk cloud auth
lk agent create

这会注册你的 Agent、创建 livekit.toml 配置文件、构建容器映像并进行部署。

部署新版本：

lk agent deploy

监控你的 Agent：

lk agent status   # Check status and replicas
lk agent logs     # View runtime logs

如需了解更多 Agent 命令，请参阅 ./references/agent-commands.md。

电话号码

搜索并购买美国电话号码：

lk number search --country-code US --area-code 415
lk number purchase --numbers +14155550100
lk number list

如需了解更多电话服务命令，请参阅 ./references/telephony-commands.md。

最佳实践

1. 保持 CLI 更新，以使用最新功能并获取错误修复。
2. 使用 lk app env -w 将凭据载入本地环境，而不是将其硬编码。
3. 使用模板，通过已配置最佳实践的模板快速启动新项目。
4. 先在本地测试，再使用 lk room join 部署到生产环境。
5. 部署后监控部署情况，使用 lk agent status 和 lk agent logs。