mix livekit (LiveKit v0.1.1)
View SourceProvides CLI commands for LiveKit operations.
Commands
Room Management:
create-token
- Create an access token for room accesslist-rooms
- List all roomscreate-room
- Create a new roomdelete-room
- Delete a roomlist-participants
- List participants in a roomremove-participant
- Remove a participant from a room
Recording and Streaming:
start-room-recording
- Start recording a roomstart-track-recording
- Start recording specific tracksstart-room-streaming
- Start streaming a room to RTMP endpointsstart-track-stream
- Start streaming specific tracks to RTMP endpointslist-egress
- List active egress operationsstop-egress
- Stop an egress operation
Room Agents:
add-agent
- Add an agent to a roomremove-agent
- Remove an agent from a roomlist-agents
- List agents in a room
Options
Common Options:
--api-key
(-k
) - LiveKit API key (required)--api-secret
(-s
) - LiveKit API secret (required)--url
(-u
) - LiveKit server URL (required for most commands)--room
(-r
) - Room name--identity
(-i
) - Participant identity--name
(-n
) - Name for new room or agent--valid-for
(-t
) - Token validity duration (e.g., "24h", "30m")
Recording and Streaming Options:
--output
(-o
) - Output path (local file or s3://bucket/path)--rtmp
- RTMP streaming URL--width
- Video width (default: 1280)--height
- Video height (default: 720)--fps
- Frames per second (default: 30)--audio-bitrate
- Audio bitrate in bps (default: 128000)--video-bitrate
- Video bitrate in bps (default: 3000000)--track-id
- Track ID for track-specific operations--egress-id
- Egress ID for stopping operations
Agent Options:
--prompt
- Initial prompt for the agent (required for add-agent)--name
- Agent name (required for add/remove agent)
Examples
# Create a token
mix livekit create-token --api-key devkey --api-secret secret --join --room my-room --identity user1 --valid-for 24h
# List rooms
mix livekit list-rooms --api-key devkey --api-secret secret --url https://my.livekit.server
# Create a room
mix livekit create-room --api-key devkey --api-secret secret --url https://my.livekit.server --name my-room
# Delete a room
mix livekit delete-room --api-key devkey --api-secret secret --url https://my.livekit.server --room my-room
# List participants
mix livekit list-participants --api-key devkey --api-secret secret --url https://my.livekit.server --room my-room
# Remove a participant
mix livekit remove-participant --api-key devkey --api-secret secret --url https://my.livekit.server --room my-room --identity user1
# Start room recording
mix livekit start-room-recording --api-key devkey --api-secret secret --url https://my.livekit.server --room my-room --output s3://bucket/recording.mp4
# Start room streaming
mix livekit start-room-streaming --api-key devkey --api-secret secret --url https://my.livekit.server --room my-room --rtmp rtmp://stream.url/live
# Add an agent to a room
mix livekit add-agent --api-key devkey --api-secret secret --url https://my.livekit.server --room my-room --name assistant --prompt "You are a helpful assistant"