Cloud Agents lets you run your agents on the same network and infrastructure that serves LiveKit Cloud. Let LiveKit handle the deployment, scaling, and serving at the edge! All you’ll need is your agents code; you can create a Dockerfile or we’ll generate one for you. From there, Cloud Agents handles the build, container storage, and deployment for you.
Currently, all administrative Cloud Agents interactions must use the LiveKit CLI, version 2.4.13
or greater. There will be dashboard access soon!
If you have not yet authenticated the CLI with any of your cloud projects, you may do so with lk cloud auth
, or be directed to the auth flow automatically on first attempt to use authenticated services. Multiple projects can be authenticated, and can be listed with lk project list
. You can choose the default project in which to deploy your Cloud Agent via lk project set-default <project-name>
, or use the global --project
flag to override the default for a single command.
lk agent create [--secrets=<SECRETS> --secrets-file=<FILE> --toml=<TOML> <WorkingDir>]
creates a Cloud Agent, to be run within the directory where the agent lives. requires a Dockerfile and a livekit.toml in this directory, both of these can be generated by this command if they don’t exist.
—-secrets
, comma separated list, optional
--secrets-file
. If both the --secrets-file
and --secrets
flag are set, the secrets will be merged with --secrets
taking precedence.--secrets-file
, optional
key=value
pairs to be provided securely to your Cloud Agent.--toml
, path, optional
livekit.toml
<WorkingDir>
defaults to the current directorylk agent status [--id=<ID> <WorkingDir>]
displays the current status for the agent including regions, current replicas, memory, cpu and requested replicas, memory, cpu
--id
, string, optionallk agent list [--id=<ID>]
lists the Cloud Agents attached to the LiveKit project
--id
, string, optional