Available CLI Client config arguments.

example usage from your multiplayer server project:

npm exec wl-cloud --authToken="YOURWLEAPITOKEN " --serverUrl="https://k8s.cloud.wonderlandengine.dev/yourServerPath"

You only need to set --workDir argument if your server is located not in the same project where your multiuser server api types package is installed. You can also set a path to the location of your WLE-API token file via --authJsonLocation or AUTH_JSON_LOCATION env var. Default for the file location is your custom server directory and the filename wle-apitoken.json. Make sure to add this file to .gitignore, so you do not expose your WLE API credentials by accident. All these arguments can be aso set via env vars: WLE_CREDENTIALS, WORK_DIR and SERVER_URL.

Please note, that you need to set the authToken and the serverUrl, otherwise the cli client will fail to start.

Hierarchy

  • CliClientArgs

Properties

access: string
authJsonLocation: string
authToken: string
commanderUrl: string
config: string
develop: boolean
force: boolean
help: boolean
hrtf: boolean
isLocalServer?: boolean
noThreads: boolean
skipConfigUpdate: boolean
updateEnv: boolean
workDir: string

Generated using TypeDoc