# Join

> Join a lobby by ID or code.

Join a lobby by ID or code.

Authentication Required: `Yes`

```bash
ugs lobby join <player-details> [options]
```

## Arguments

`<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.

## Options

| Option           | Alias                  | Description                         |
| ---------------- | ---------------------- | ----------------------------------- |
| service-id       | --service-id           | (REQUIRED) The service ID.          |
| lobby-id         | --lobby-id             | The ID of the lobby to join.        |
| lobby-code       | --lobby-code           | The join code of the lobby to join. |
| project-id       | -p, --project-id       | The Unity cloud project ID.         |
| environment-name | -e, --environment-name | The services environment name.      |
| help             | -?, -h, --help         | Display help and usage information. |
| quiet            | -q, --quiet            | Reduce logging to a minimum.        |
| json             | -j, --json             | Use JSON as the output format.      |

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