Skip to main content


Join a lobby by ID or code.

Authentication Required: Yes

ugs lobby join <player-details> [options]


<player-details> The JSON player details. If this is a file path, the content of the file is used; otherwise, the raw string is used.


service-id--service-id(REQUIRED) The service ID.
lobby-id--lobby-idThe ID of the lobby to join.
lobby-code--lobby-codeThe join code of the lobby to join.
project-id-p, --project-idThe Unity cloud project ID.
environment-name-e, --environment-nameThe services environment name.
help-?, -h, --helpDisplay help and usage information.
quiet-q, --quietReduce logging to a minimum.
json-j, --jsonUse JSON as the output format.

Either --lobby-id or --lobby-code is required, but not both.