id       = "livekit"
name     = "LiveKit CLI"
homepage = "https://github.com/livekit/livekit-cli"
description = "Command line interface to LiveKit."
executables   = ["lk"]

[dotfiles]

# The official CLI source loads and persists its user CLI configuration at
# ~/.livekit/cli-config.yaml. It contains project API keys and secrets, so the
# complete file is treated as a credential. The separate livekit.toml used by
# agent projects is a working-directory file, not a user dotfile.
# https://github.com/livekit/livekit-cli/blob/main/pkg/config/config.go
paths = []
exclude = []
secret = ["~/.livekit/cli-config.yaml"]

[commands]
format = 1
label = "LiveKit CLI"
description = "Common LiveKit CLI jobs: join a room and scaffold an app from a template. Only options shown in the official README are included."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.subcommand]]
path = ["room", "join"]
label = "Join a room"

[[commands.subcommand.source]]
id = "readme"
kind = "manual"
url = "https://raw.githubusercontent.com/livekit/livekit-cli/main/README.md"
revision = "2026-10-27"
evidence = """
lk room join --identity publisher \
  --attribute key1=value1 \
  --attribute key2=value2 \
  <room_name>
lk room join --identity publisher \
  --attribute-file attributes.json \
  <room_name>
"""

[[commands.subcommand.field]]
id = "room"
label = "Room name"
type = "string"
position = 0
sources = ["readme"]

[[commands.subcommand.field]]
id = "identity"
label = "Identity"
type = "string"
option = ["--identity"]
sources = ["readme"]

[[commands.subcommand.field]]
id = "attribute"
label = "Attribute (key=value)"
type = "string"
option = ["--attribute"]
multiple = true
sources = ["readme"]

[[commands.subcommand.field]]
id = "attribute_file"
label = "Attributes JSON file"
type = "path"
option = ["--attribute-file"]
path = { kind = "file", role = "input", must_exist = true }
sources = ["readme"]

[[commands.subcommand.task]]
id = "join"
label = "Join room"
fields = ["room", "identity", "attribute"]
required = ["room", "identity"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["room", "identity", "attribute", "attribute_file"]

[[commands.subcommand]]
path = ["app", "create"]
label = "Create an app from a template"

[[commands.subcommand.source]]
id = "readme"
kind = "manual"
url = "https://raw.githubusercontent.com/livekit/livekit-cli/main/README.md"
revision = "2026-10-27"
evidence = """
lk app create --template <template_name> my-app
"""

[[commands.subcommand.field]]
id = "name"
label = "App directory name"
type = "string"
position = 0
sources = ["readme"]

[[commands.subcommand.field]]
id = "template"
label = "Template"
type = "string"
option = ["--template"]
sources = ["readme"]

[[commands.subcommand.task]]
id = "create"
label = "Create app"
fields = ["name", "template"]
required = ["name", "template"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["name", "template"]