Init

Initialize a new Beamable project in the current directory

beam init [<path>] [options]

About

The init command is used for initializing a .beamable folder. A .beamable folder provides
contextual information to later invocations of the CLI. The folder has Beamable connection strings and
authorization information that can be used later.

Arguments

Name	Type	Description
path	String	the folder that will be initialized as a beamable project. . By default, the init command creates a `.beamable` folder in the current directory. However, the `path` argument configures where the `.beamable` folder is created.

Options

Name	Type	Description
--email	String	Specify user email address
--password	String	User password
--host	String	The host endpoint for beamable
--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
--refresh-token	String	Refresh token to use for the requests
--save-extra-paths	List`1	Overwrite the stored extra paths for where to find projects
--paths-to-ignore	List`1	Paths to ignore when searching for services
--save-to-environment	Boolean	Save login refresh token to environment variable
--no-token-save	Boolean	Prevent auth tokens from being saved to disk. This replaces the legacy --save-to-file option
--customer-scoped	Boolean	Make request customer scoped instead of product only
--print-to-console	Boolean	Prints out login request response to console
--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

Updated 10 days ago