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

NameTypeDescription
pathStringthe 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

NameTypeDescription
--emailStringSpecify user email address
--passwordStringUser password
--hostStringThe host endpoint for beamable
--cidStringCid to use; will default to whatever is in the file system
--pidStringPid to use; will default to whatever is in the file system
--refresh-tokenStringRefresh token to use for the requests
--save-to-environmentBooleanSave login refresh token to environment variable
--no-token-saveBooleanPrevent auth tokens from being saved to disk. This replaces the legacy --save-to-file option
--customer-scopedBooleanMake request customer scoped instead of product only
--print-to-consoleBooleanPrints out login request response to console
--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
--refresh-tokenStringRefresh token to use for the requests
--logStringExtra logs gets printed out
--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