API reference / @backpack/cli / ProjectOptions

Interface: ProjectOptions

Properties

appName

appName: string;

Name of the app.

---

components

components: object;

Components to include.

Name	Type
appConfig	RequiredIfEnabled<{ enabled: boolean; }>
appSecrets	RequiredIfEnabled<{ awsProfileDev?: string; createDevSecret: boolean; enabled: boolean; }>
datadogMonitoring	RequiredIfEnabled<{ enabled: boolean; }>
dynamoDb	RequiredIfEnabled<{ enabled: boolean; tableName: string; }>
restApi	RequiredIfEnabled<{ enabled: boolean; }>

---

environments

environments: object;

Environment config.

Name	Type
awsAccountIds	Record<"dev" | "stg" | "prd", string | undefined>
onlyDev	boolean

---

gitInit

gitInit: boolean;

Whether to initialize Git.

---

npmInstall

npmInstall: boolean;

Whether to run NPM install.

---

targetDirectory

targetDirectory: string;

Where to create the project.

---

teamName?

optional teamName: string;

Name of the team.