This content is not the latest documentation. Please visit our new documentation.

Content Sync

Synchronizes the local content matching the filters to the latest content stored in the realm

beam content sync [options]

About

Synchronizes the local content matching the filters to the latest content stored in the realm

Options

NameTypeDescription
--manifest-idsString[]Inform a subset of ','-separated manifest ids for which to return data. By default, will return just the global manifest
--filter-typeContentFilterTypeDefines the semantics for the filter argument. When no filters are given, affects all existing content.

ExactIds => Will only add the given tags to the ','-separated list of filters
Regexes => Will add the given tags to any content whose Id is matched by any of the ','-separated list of filters (C# regex string)
TypeHierarchy => Will add the given tags to any content of the ','-separated list of filters (content type strings with full hierarchy --- StartsWith comparison)
Tags => Will add the given tags to any content that currently has any of the ','-separated list of filters (tags)|
|--filter|String|Accepts different strings to filter which content files will be affected. See the filter-type option|
|--sync-created|Boolean|Deletes any created content that is not present in the latest manifest. If filters are provided, will only delete the created content that matches the filter|
|--sync-modified|Boolean|This will discard your local changes ONLY on files that are NOT conflicted. If filters are provided, will only do this for content that matches the filter|
|--sync-conflicts|Boolean|This will discard your local changes ONLY on files that ARE conflicted. If filters are provided, will only do this for content that matches the filter|
|--sync-deleted|Boolean|This will revert all your deleted files. If filters are provided, will only do this for content that matches the filter|
|--target|String|If you pass in a Manifest's UID, we'll sync with that as the target. If filters are provided, will only do this for content that matches the filter|
|--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'|
|--engine|String|If passed, sets the engine integration that is calling for the command|
|--engine-sdk-version|String|The version of the Beamable's SDK running in that Engine|
|--engine-version|String|The version of the engine that is calling the CLI|
|--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|

Parent Command

content