OS Manuals

/usr/bin/lk

Command line interface to LiveKit

From livekit-cli 2.19.3-r2 (enterprise-packages), captured 2026-11-08 by running lk --help (exit 0). permalink

NAME:
   lk - The LiveKit command line tool

USAGE:
   lk [global options] command [command options] [arguments...]

VERSION:
   2.19.3

DESCRIPTION:
   Build, test, and deploy LiveKit agents, and work with rooms, LiveKit Cloud,
   and telephony from the terminal.

   Docs: https://docs.livekit.io/intro/basics/cli/

AGENTS:
   agent init      Create a new agent project from a template
   agent dev       Run an agent locally with hot reload
   agent start     Run an agent locally in production mode
   agent console   Talk to a local agent yourself, by voice or by typing
   agent debugger  Drive a conversation with a local agent from a script or coding agent
   agent simulate  Run judged simulations of an agent on LiveKit Cloud

AGENT DEPLOYMENT (LIVEKIT CLOUD):
   agent create          Create and deploy a new agent on LiveKit Cloud
   agent dockerfile      Generate Dockerfile and .dockerignore for your project
   agent config          Write a livekit.toml for an existing agent into the working directory
   agent deploy          Deploy a new version of the agent
   agent promote         Promote an agent to a new deployment
   agent status          Get the status of an agent
   agent update          Update an agent's metadata and secrets (restarts the agent)
   agent restart         Restart an agent
   agent rollback        Roll back an agent to a previous version
   agent logs            Tail an agent's logs
   agent delete          Delete an agent
   agent versions        List versions of an agent
   agent list            List the agents in the current project
   agent secrets         List an agent's secrets
   agent update-secrets  Update an agent's secrets (restarts the agent)
   agent private-link    Manage private links for agents

PROJECTS:
   project  Add or remove projects and view existing project properties
   cloud    Interact with LiveKit Cloud services
   app      Initialize and manage applications

ROOMS AND MEDIA:
   room      Create or delete rooms and manage existing room properties
   token     Create access tokens with granular capabilities
   dispatch  Create, list, and delete agent dispatches
   egress    Record or stream media from LiveKit to elsewhere
   ingress   Import outside media sources into a LiveKit room

TELEPHONY:
   sip     Manage SIP Trunks, Dispatch Rules, and Participants
   number  Manage phone numbers

TOOLS:
   docs        Search and browse LiveKit documentation
   skills      Install LiveKit's skills and Docs MCP server into your coding agents
   perf        Performance testing commands
   update      Update the CLI to the latest version
   can-update  Check whether a newer CLI version is available

Run "lk <command> --help" for details; "lk a" is short for "lk agent".

GLOBAL OPTIONS:
   --url URL              URL to LiveKit instance (default: "http://localhost:7880") [$LIVEKIT_URL]
   --api-key KEY          Your KEY [$LIVEKIT_API_KEY]
   --api-secret SECRET    Your SECRET [$LIVEKIT_API_SECRET]
   --dev                  Use developer credentials for local LiveKit server
   --project NAME         NAME of a configured project
   --subdomain SUBDOMAIN  SUBDOMAIN of a configured project
   --config TOML          Config TOML to use in the working directory (default: "livekit.toml")
   --curl                 Print curl commands for API actions
   --verbose
   --yes, -y              Assume yes for confirmations; fail or use default for other prompts (use in CI/non-interactive)
   --quiet, -q, --silent  Suppress informational output to stderr (warnings and errors still print)
   --help, -h             show help
   --version, -v          print the version
Options (13)
OptionDescriptionSource
--url URLURL to LiveKit instance (default: "http://localhost:7880") [$LIVEKIT_URL]help
--api-key KEYYour KEY [$LIVEKIT_API_KEY]help
--api-secret SECRETYour SECRET [$LIVEKIT_API_SECRET]help
--devUse developer credentials for local LiveKit serverhelp
--project NAMENAME of a configured projecthelp
--subdomain SUBDOMAINSUBDOMAIN of a configured projecthelp
--config TOMLConfig TOML to use in the working directory (default: "livekit.toml")help
--curlPrint curl commands for API actionshelp
--verbosehelp
--yes, -yAssume yes for confirmations;help
--quiet, -q, --silentSuppress informational output to stderr (warnings and errors still print)help
--help, -hshow helphelp
--version, -vprint the versionhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.