livekit-cli

LiveKit CLI

LiveKit CLI（lk）は、LiveKit Cloud プロジェクトの管理、テンプレートからのアプリケーション作成、エージェントのデプロイ、テレフォニーの設定を行うコマンドラインツールを提供します。

LiveKit MCP サーバーのツール

このスキルは LiveKit MCP サーバーと連携して動作し、最新の LiveKit ドキュメント、コード例、変更履歴に直接アクセスできます。このスキルの作成後に変更された可能性のある最新情報が必要な場合は、これらのツールを使用してください。

利用可能な MCP ツール：

• docs_search - LiveKit ドキュメントサイトを検索します
• get_pages - パスを指定して特定のドキュメントページを取得します
• get_changelog - LiveKit パッケージの最近のリリースと更新情報を取得します
• code_search - LiveKit リポジトリを検索してコード例を探します
• get_python_agent_example - 100 件以上の Python エージェントの例を閲覧します

MCP ツールを使用する場面：

• 最新の API ドキュメントや機能の更新情報が必要な場合
• 最近の例やコードパターンを探している場合
• 最近のリリースで機能が追加されたか確認したい場合
• ローカルのリファレンスに特定のトピックが含まれていない場合

ローカルのリファレンスを使用する場面：

• このスキルで扱う基本概念にすばやくアクセスしたい場合
• オフラインで作業している場合、または一般的なパターンにすばやくアクセスしたい場合
• リファレンスの情報で十分な場合

最適な利用体験のため、MCP ツールとローカルのリファレンスを併用してください。

リファレンス

必要に応じて、以下のリソースを参照してください。

• ./references/livekit-overview.md -- LiveKit エコシステムの概要
• ./references/project-commands.md -- プロジェクト管理とトークン生成
• ./references/agent-commands.md -- エージェントのデプロイと管理
• ./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-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	マルチエージェントのワークフロー例
outbound-caller-python	発信エージェント

注： テンプレートは随時更新されることがあります。現在の一覧を対話形式で確認するには、引数を指定せずに 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

エージェントをデプロイする

最初のエージェントを LiveKit Cloud にデプロイします。

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

エージェントを登録し、livekit.toml 構成ファイルを作成して、コンテナイメージをビルドし、デプロイします。

新しいバージョンをデプロイします。

lk agent deploy

エージェントを監視します。

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

エージェントのその他のコマンドについては、./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 を使ってデプロイを監視します。