Project New Service
Create a new microservice project
beam project new service <name> [options]
About
Create a new microservice project
Arguments
| Name | Type | Description |
|---|---|---|
| name | ServiceName | Name of the new project |
Options
| Name | Type | Description |
|---|---|---|
| --sln | String | Relative path to the .sln file to use for the new project. If the .sln file does not exist, it will be created. When no option is configured, if this command is executing inside a .beamable folder, then the first .sln found in .beamable/.. will be used. If no .sln is found, the .sln path will be .sln. If no .beamable folder exists, then the /.sln will be used |
| --service-directory | String | Relative path to directory where project should be created. Defaults to "SOLUTION_DIR/services" |
| --link-to | List`1 | The name of the storage to link this service to |
| --groups | List`1 | Specify BeamableGroups for this service |
| --generate-common | Boolean | If passed, will create a common library for this project |
| --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 |
Parent Command
Updated 10 days ago