Listen Player
Listen for player notifications
beam listen player [options]
About
The listen player command will monitor events sent to the logged in
player on the CLI. Player events include updates such as content
notifications, inventory updates, mail updates, and more.
IMPORTANT: The command only works if the realm is configured to use
Beamable Notifications, which is the default setting for new realms
as of July 2023. However, if the realm is not using Beamable Notifications,
the following error will be displayed.
Only realms with beam notifications are supported. This realm currently has pubnub.
Try setting the realm config to beam with this command,
""beam config realm set --key-values 'notification|publisher::beamable'""
To get started with the command, make sure you have the CLI configured,
and an available player.
- Run
beam me
to get access to the player'splayerId
. - Use the portal, and navigate to the player's inventory page.
- Run
beam listen player
, and leave the program running. This starts the listening process. - On the portal, change the player's currency value. Alternatively, send the player some mail.
- On the console, notice the event is received.
Options
Name | Type | Description |
---|---|---|
--context | String | A regex to filter for notification channels |
--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 |
--access-token | String | The access token to use for the requests |
--refresh-token | String | Refresh token to use for the requests |
--log | String | Extra logs gets printed out |
--no-redirect | Boolean | If there is a local dotnet tool installation (with a ./config/dotnet-tools.json file) for the beam tool, then any global invocation of the beam tool will automatically redirect and call the local version. However, there will be a performance penalty due to the extra process invocation. This option flag will cause an error to occur instead of automatically redirecting the execution to a new process invocation. |
--unmask-logs | Boolean | By default, logs will automatically mask tokens. However, when this option is enabled, tokens will be visible in their full text. This is a security risk. |
--no-log-file | Boolean | By default, logs are automatically written to a temp file so that they can be used in an error case. However, when this option is enabled, logs are not written. Also, if the BEAM_CLI_NO_FILE_LOG environment variable is set, no log file will be written. |
--docker-cli-path | String | a custom location for docker. By default, the CLI will attempt to resolve docker through its usual install locations. You can also use the BEAM_DOCKER_EXE environment variable to specify. |
Currently, a docker path has been automatically identified. | ||
--emit-log-streams | Boolean | Out all log messages as data payloads in addition to however they are logged |
--add-project-path | IEnumerable`1 | additional file paths to be included when building a local project manifest. |
--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 10 days ago