@vttforge/cli / InitOptions

Interface: InitOptions

Properties

author?

optional author?: string

Author name for the manifest. Defaults to the local git author.

---

cwd?

optional cwd?: string

Override the working directory (test hook). Defaults to process.cwd().

---

description?

optional description?: string

One-line description for the manifest.

---

id?

optional id?: string

Manifest id. Defaults to a slug of the directory name.

---

lang?

optional lang?: "ts" | "js"

---

license?

optional license?: string

SPDX license id written to package.json.

---

name?

optional name?: string

---

noGit?

optional noGit?: boolean

---

noInstall?

optional noInstall?: boolean

---

title?

optional title?: string

Human-readable title shown in Foundry's setup screens.

---

type?

optional type?: "system" | "module"

---

yes?

optional yes?: boolean

Take the default for anything not supplied instead of asking.

Required to scaffold without a terminal: a prompt with nothing to read from waits forever, which is no way to fail.