util

package

v2.16.1 Latest Latest Go to latest Published: Apr 14, 2026 License: Apache-2.0 Imports: 27 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/livekit/livekit-cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Await(title string, ctx context.Context, action func(ctx context.Context) error) error
func CopyFile(src, dest string) error
func CreateTable() *table.Table
func EllipsizeTo(str string, maxLength int) string
func ExpandTemplate(template string) string
func ExtractSubdomain(url string) string
func FileExists(dir fs.FS, filename string) bool
func HashString(str string) (string, error)
func MapStrings(strs []string, fn func(string) string) []string
func MoveDir(src, dest string) error
func OpenInConsole(dashboardURL, projectId string, params *ConsoleURLParams) error
func OpenInMeet(livekitURL, token string) error
func PrintJSON(obj any)
func PrintJSONTo(w io.Writer, obj any) error
func ToUnixPath(p string) string
func URLSafeName(projectURL string) (string, error)
func UseTempPath(permanentPath string) (string, func() error, func() error)
func WrapToLines(input string, maxLineLength int) []string
func WrapWith(wrap string) func(string) string
type ConsoleURLParams
type OpenTarget

Constants ¶

View Source

const (
	MeetURL        = "https://meet.livekit.io/custom"
	ConsoleURLPath = "/projects/%s/agents/console/?"
)

Variables ¶

View Source

var (
	Theme = func() *huh.Theme {
		t := huh.ThemeBase16()
		t.Focused.FocusedButton = t.Focused.FocusedButton.Foreground(lipgloss.Color("7")).Background(lipgloss.Color("4"))
		t.Focused.TextInput.Cursor.Foreground(lipgloss.Color("4"))
		return t
	}()

	Accented = func(text string) string {
		return Theme.Focused.Title.Render(text)
	}
	Dimmed = func(text string) string {
		return Theme.Focused.Description.Render(text)
	}

	Fg              = lipgloss.AdaptiveColor{Light: "235", Dark: "252"}
	FormBaseStyle   = Theme.Form.Base.Foreground(Fg).Padding(0, 1)
	FormHeaderStyle = FormBaseStyle.Bold(true)
)

View Source

var (
	OpenFlag = &cli.StringFlag{
		Name:  "open",
		Usage: fmt.Sprintf("Open relevant `APP` in browser, supported options: %v", options),
		Validator: func(input string) error {
			if !slices.Contains(options, input) {
				return fmt.Errorf("invalid open target: %s, supported options: %v", input, options)
			}
			return nil
		},
	}
)

Functions ¶

func Await ¶ added in v2.4.9

func Await(title string, ctx context.Context, action func(ctx context.Context) error) error

Call an action and show a spinner while waiting for it to finish.

func CopyFile ¶

func CopyFile(src, dest string) error

Safely copy a file across filesystems, preserving permissions

func CreateTable ¶

func CreateTable() *table.Table

func EllipsizeTo ¶

func EllipsizeTo(str string, maxLength int) string

func ExpandTemplate ¶ added in v2.4.13

func ExpandTemplate(template string) string

func ExtractSubdomain ¶ added in v2.4.6

func ExtractSubdomain(url string) string

func FileExists ¶ added in v2.5.0

func FileExists(dir fs.FS, filename string) bool

func HashString ¶

func HashString(str string) (string, error)

func MapStrings ¶

func MapStrings(strs []string, fn func(string) string) []string

func MoveDir ¶

func MoveDir(src, dest string) error

Safely move a directory across filesystems, preserving permissions

func OpenInConsole ¶ added in v2.16.1

func OpenInConsole(dashboardURL, projectId string, params *ConsoleURLParams) error

func OpenInMeet ¶ added in v2.4.13

func OpenInMeet(livekitURL, token string) error

func PrintJSON ¶

func PrintJSON(obj any)

func PrintJSONTo ¶ added in v2.15.1

func PrintJSONTo(w io.Writer, obj any) error

func ToUnixPath ¶ added in v2.5.2

func ToUnixPath(p string) string

Converts a path (possibly Windows-style) to a Unix-style path.

func URLSafeName ¶

func URLSafeName(projectURL string) (string, error)

func UseTempPath ¶

func UseTempPath(permanentPath string) (string, func() error, func() error)

Provides a temporary path, a function to relocate it to a permanent path, and a function to clean up the temporary path that should always be deferred in the case of a failure to relocate.

func WrapToLines ¶

func WrapToLines(input string, maxLineLength int) []string

func WrapWith ¶

func WrapWith(wrap string) func(string) string

Types ¶

type ConsoleURLParams ¶ added in v2.16.1

type ConsoleURLParams struct {
	AgentName    string            `url:"agentName,omitempty"`
	JobMetadata  string            `url:"jobMetadata,omitempty"`
	RoomName     string            `url:"roomName,omitempty"`
	RoomMetadata string            `url:"roomMetadata,omitempty"`
	Identity     string            `url:"identity,omitempty"`
	Metadata     string            `url:"metadata,omitempty"`
	Attributes   map[string]string `url:"attributes,omitempty"`
	Hidden       bool              `url:"hidden,omitempty"`
	AutoStart    bool              `url:"autoStart,omitempty"`
}

type OpenTarget ¶ added in v2.4.13

type OpenTarget string

const (
	OpenTargetMeet    OpenTarget = "meet"
	OpenTargetConsole OpenTarget = "console"
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL