Oapi Generate

[INTERNAL] Generate Beamable client source code from open API documents

beam oapi generate [options]

About

[INTERNAL] Generate Beamable client source code from open API documents

Options

NameTypeDescription
--concatBooleanWhen true, all the generated code will be in one file. When false, there will be multiple files
--outputStringWhen null or empty, the generated code will be sent to standard-out. When there is a output value, the file or files will be written to the path
--filterStringFilter which open apis to generate. An empty string matches everything
--engineStringFilter which engine code we should generate (unity
--conflict-strategyGenerateSdkConflictResolutionStrategyWhen multiple openAPI documents identify a schema with the same name, this flag controls how the conflict is resolved
--cleaning-strategyCleaningStrategySpecifies what should happened with directory output
--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
--access-tokenStringThe access token to use for the requests
--refresh-tokenStringRefresh token to use for the requests
--logStringExtra logs gets printed out
--no-redirectBooleanIf 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-logsBooleanBy 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-fileBooleanBy 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-pathStringa 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-streamsBooleanOut all log messages as data payloads in addition to however they are logged
--add-project-pathIEnumerable`1additional file paths to be included when building a local project manifest.
--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

oapi