Listen Server
Listen to server events
beam listen server [options]
About
The listen server command will monitor realm events, such as content publications
or changes to realm configuration. Realm events are sent through a websocket
connection, and require admin level privileges.
This command is meant only as a diagnostic tool, and does not have robust
connection recovery logic.
To get started with the command, make sure you have the CLI configured,
and an available player.
- Run
beam listen server
, and leave the process running. - Open portal, and navigate to the realm config page. Add a new configuration setting.
- On the console, notice that the new configuration has been received.
Options
Name | Type | Description |
---|---|---|
--dryrun | Boolean | Should any networking happen? |
--cid | String | Cid to use; will default to whatever is in the file system |
--pid | String | Pid to use; will default to whatever is in the file system |
--quiet | Boolean | When true, skip input waiting and use defaults |
--host | String | The host endpoint for beamable |
--refresh-token | String | Refresh token to use for the requests |
--log | String | Extra logs gets printed out |
--dir | String | Directory to use for configuration |
--raw | Boolean | Output raw JSON to standard out. This happens by default when the command is being piped |
--pretty | Boolean | Output syntax highlighted box text. This happens by default when the command is not piped |
--dotnet-path | String | a custom location for dotnet |
--version | Boolean | Show version information |
--help | Boolean | Show help and usage information |
Parent Command
Updated 6 months ago