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 |
|---|---|---|
| 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-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 |
| --refresh-token | String | Refresh token to use for the requests |
| --log | String | Extra logs gets printed out |
| --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 2 months ago
