diff --git a/cmd/lk/dispatch.go b/cmd/lk/dispatch.go index 8d772b19..a80ee0c3 100644 --- a/cmd/lk/dispatch.go +++ b/cmd/lk/dispatch.go @@ -37,6 +37,7 @@ var ( Usage: "List all agent dispatches in a room", Before: createDispatchClient, Action: listAgentDispatches, + Flags: []cli.Flag{jsonFlag}, ArgsUsage: "ROOM_NAME", }, { @@ -44,6 +45,7 @@ var ( Usage: "Get an agent dispatch by room and ID", Before: createDispatchClient, Action: getAgentDispatch, + Flags: []cli.Flag{jsonFlag}, ArgsUsage: "ROOM_NAME ID", }, { @@ -73,6 +75,7 @@ var ( Name: "metadata", Usage: "metadata to send to agent", }, + jsonFlag, }, }, { @@ -80,6 +83,7 @@ var ( Usage: "Delete an agent dispatch", Before: createDispatchClient, Action: deleteAgentDispatch, + Flags: []cli.Flag{jsonFlag}, ArgsUsage: "ROOM_NAME ID", }, }, diff --git a/cmd/lk/egress.go b/cmd/lk/egress.go index 9cf490e4..09c15f5c 100644 --- a/cmd/lk/egress.go +++ b/cmd/lk/egress.go @@ -62,7 +62,7 @@ TYPE selects a deprecated per-type request instead: - "track-composite" captures an audio and a video track, as ` + reflect.TypeFor[livekit.TrackCompositeEgressRequest]().Name() + ` - "web" captures any website, with a lifecycle detached from LiveKit rooms, as ` + reflect.TypeFor[livekit.WebEgressRequest]().Name() + ` -See cmd/livekit-cli/examples` +See cmd/lk/examples` ) var ( @@ -130,8 +130,8 @@ var ( Action: testEgressTemplate, Flags: []cli.Flag{ &cli.StringFlag{ - Name: "base-url (e.g. https://recorder.livekit.io/#)", - Usage: "Base template `URL`", + Name: "base-url", + Usage: "Base template `URL` (e.g. https://recorder.livekit.io/#)", Required: true, }, &cli.StringFlag{ @@ -151,11 +151,10 @@ var ( }, }, { - Name: "update-layout", - Usage: "Updates layout for a live room composite egress", - ArgsUsage: "ID", - Before: createEgressClient, - Action: updateLayout, + Name: "update-layout", + Usage: "Updates layout for a live room composite egress", + Before: createEgressClient, + Action: updateLayout, Flags: []cli.Flag{ &cli.StringFlag{ Name: "id", @@ -220,7 +219,7 @@ var ( Flags: []cli.Flag{ &cli.StringFlag{ Name: "request", - Usage: "WebEgressRequest as json file (see cmd/livekit-cli/examples)", + Usage: "WebEgressRequest as json file (see cmd/lk/examples)", Required: true, }, }, @@ -234,7 +233,7 @@ var ( Flags: []cli.Flag{ &cli.StringFlag{ Name: "request", - Usage: "ParticipantEgressRequest as json file (see cmd/livekit-cli/examples)", + Usage: "ParticipantEgressRequest as json file (see cmd/lk/examples)", Required: true, }, }, @@ -248,7 +247,7 @@ var ( Flags: []cli.Flag{ &cli.StringFlag{ Name: "request", - Usage: "TrackCompositeEgressRequest as json file (see cmd/livekit-cli/examples)", + Usage: "TrackCompositeEgressRequest as json file (see cmd/lk/examples)", Required: true, }, }, @@ -262,7 +261,7 @@ var ( Flags: []cli.Flag{ &cli.StringFlag{ Name: "request", - Usage: "TrackEgressRequest as json file (see cmd/livekit-cli/examples)", + Usage: "TrackEgressRequest as json file (see cmd/lk/examples)", Required: true, }, }, @@ -352,8 +351,8 @@ var ( Action: testEgressTemplate, Flags: []cli.Flag{ &cli.StringFlag{ - Name: "base-url (e.g. https://recorder.livekit.io/#)", - Usage: "Base template `URL`", + Name: "base-url", + Usage: "Base template `URL` (e.g. https://recorder.livekit.io/#)", Required: true, }, &cli.StringFlag{ diff --git a/cmd/lk/examples/auto-participant-egress.json b/cmd/lk/examples/auto-participant-egress.json new file mode 100644 index 00000000..de5870c1 --- /dev/null +++ b/cmd/lk/examples/auto-participant-egress.json @@ -0,0 +1,14 @@ +{ + "preset": "H264_720P_30", + "file_outputs": [ + { + "filepath": "{room_name}/{publisher_identity}-{time}.mp4", + "s3": { + "access_key": "aws-access-key", + "secret": "aws-access-secret", + "region": "aws-region", + "bucket": "my-bucket" + } + } + ] +} diff --git a/cmd/lk/phone_number.go b/cmd/lk/phone_number.go index d4be2b0a..3de199e0 100644 --- a/cmd/lk/phone_number.go +++ b/cmd/lk/phone_number.go @@ -68,6 +68,7 @@ var ( Name: "sip-dispatch-rule-id", Usage: "SIP dispatch rule ID to apply to all purchased numbers", }, + jsonFlag, }, }, { @@ -109,6 +110,7 @@ var ( Name: "number", Usage: "Use phone number string for lookup", }, + jsonFlag, }, ArgsUsage: "Either --id or --number must be provided", }, @@ -129,6 +131,7 @@ var ( Name: "sip-dispatch-rule-id", Usage: "SIP dispatch rule ID to assign to the phone number", }, + jsonFlag, }, ArgsUsage: "Either --id or --number must be provided", }, diff --git a/cmd/lk/room.go b/cmd/lk/room.go index 9ebab693..767bf0fd 100644 --- a/cmd/lk/room.go +++ b/cmd/lk/room.go @@ -122,9 +122,9 @@ var ( Before: createRoomClient, Action: updateRoomMetadata, Flags: []cli.Flag{ - hidden(optional(roomFlag)), &cli.StringFlag{ Name: "metadata", + Usage: "New room `METADATA` (required)", Required: true, }, }, @@ -136,7 +136,7 @@ var ( UsageText: "lk room delete [OPTIONS] ROOM_NAME", Before: createRoomClient, Action: deleteRoom, - ArgsUsage: "ROOM_NAME_OR_ID", + ArgsUsage: "ROOM_NAME", }, { Name: "join", @@ -212,7 +212,7 @@ var ( Commands: []*cli.Command{ { Name: "list", - Usage: "List or search for active rooms by name", + Usage: "List participants in a room", Action: listParticipants, ArgsUsage: "ROOM_NAME", }, diff --git a/cmd/lk/sip.go b/cmd/lk/sip.go index 71d08241..a997f119 100644 --- a/cmd/lk/sip.go +++ b/cmd/lk/sip.go @@ -315,7 +315,7 @@ var ( Name: "delete", Usage: "Delete SIP Dispatch Rule", Action: deleteSIPDispatchRule, - ArgsUsage: "SIPTrunk ID to delete", + ArgsUsage: "SIPDispatchRule ID to delete", }, }, }, @@ -486,15 +486,15 @@ func appendSIPMediaFlags(flags []cli.Flag) []cli.Flag { flags = append(flags, &cli.StringFlag{ Name: "media-enc", - Usage: "Sets media encryption for outbound call", + Usage: "Sets media encryption for calls", }, &cli.BoolFlag{ Name: "no-default-codecs", - Usage: "Disables a builtin list of default SIP codecs", + Usage: "Disables a builtin list of default SIP codecs, so only those in --codecs are used. Has no effect without --codecs", }, &cli.StringSliceFlag{ Name: "codecs", - Usage: "Sets a list of SIP codecs for outbound call", + Usage: "Sets a list of SIP codecs for calls", }, ) return flags diff --git a/cmd/lk/token.go b/cmd/lk/token.go index ef52cd8c..479c1a0c 100644 --- a/cmd/lk/token.go +++ b/cmd/lk/token.go @@ -250,7 +250,7 @@ func createToken(ctx context.Context, c *cli.Command) error { name := c.String("name") metadata := c.String("metadata") validFor := c.String("valid-for") - roomPreset := c.String("room-preset") + roomPreset := c.String("room-configuration") participantAttributes, err := parseKeyValuePairs(c, "attribute") if err != nil { return fmt.Errorf("failed to parse participant attributes: %w", err)