Project

Commands that relate to a standalone Beamable project

beam project [options]

About

Commands that relate to a standalone Beamable project

Options

Name	Type	Description
--dryrun	Boolean	[DEPRECATED] Run as much of the command as possible without making any network calls
--cid	String	CID (CustomerId) to use (found in Portal->Account); defaults to whatever is in '.beamable/connection-configuration.json'
--pid	String	PID (Realm ID) to use (found in Portal -> Games -> Any Realm's details); defaults to whatever is in '.beamable/connection-configuration.json'
--quiet	Boolean	When true, skip input waiting and use default arguments (or error if no defaults are possible)
--host	String	This option defines the target Beamable environment. Needed for private cloud customers to target their exclusive Beamable environment. Ignorable by everyone else. Stored in '.beamable/connection-configuration.json'
--access-token	String	The access token to use for the requests. It overwrites the logged in user stored in connection-auth.json for THIS INVOCATION ONLY
--refresh-token	String	A Refresh Token to use for the requests. It overwrites the logged in user stored in connection-auth.json for THIS INVOCATION ONLY
--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.
--prefer-remote-federation	Boolean	By default, any local CLI invocation that should trigger a Federation of any type will prefer locally running Microservices. However, if you need the CLI to use the remotely running Microservices, use this option to ignore locally running services.
--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	[DEPRECATED] Path override for the .beamable folder
--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

Sub Commands

project-add-unity-project
project-add-unreal-project
project-build
project-dependencies
project-deps
project-disable
project-enable
project-generate-client
project-generate-ignore-file
project-generate-properties
project-group
project-list
project-logs
project-new
project-oapi
project-open
project-open-mongo
project-open-swagger
project-ps
project-regenerate
project-remove
project-run
project-share-code
project-stop
project-storage
project-update-unity-beam-package
project-generate-env
project-read-settings
project-remote-logs
project-remote-manifest
project-write-setting

Updated 2 months ago