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.

  1. Run beam listen server, and leave the process running.
  2. Open portal, and navigate to the realm config page. Add a new configuration setting.
  3. On the console, notice that the new configuration has been received.

Options

NameTypeDescription
--dryrunBooleanShould any networking happen?
--cidStringCid to use; will default to whatever is in the file system
--pidStringPid to use; will default to whatever is in the file system
--quietBooleanWhen true, skip input waiting and use defaults
--hostStringThe host endpoint for beamable
--refresh-tokenStringRefresh token to use for the requests
--logStringExtra logs gets printed out
--dirStringDirectory to use for configuration
--rawBooleanOutput raw JSON to standard out. This happens by default when the command is being piped
--prettyBooleanOutput syntax highlighted box text. This happens by default when the command is not piped
--dotnet-pathStringa custom location for dotnet
--versionBooleanShow version information
--helpBooleanShow help and usage information

Parent Command

listen