Expand description
Scaffold a new mz-deploy project directory.
Creates the standard directory layout (models/, clusters/, roles/),
writes starter project.toml and profiles.toml files, and optionally
initializes a git repository.
Structsยง
- Scaffold
Opts - Shared options for project scaffolding.
Constantsยง
- GITIGNORE ๐
- PROJECT_
TOML ๐ - README_
MD ๐ - VSCODE_
EXTENSIONS_ ๐JSON
Functionsยง
- add_
file ๐ - Writes a scaffold file, leaving any file that already exists untouched.
- create_
dir ๐ - init
mz-deploy initโ scaffold the current directory as an mz-deploy project.- print_
profile_ ๐help_ hint - One-line nudge to the help page; appended to every profile-prompt outcome.
- print_
skill_ ๐hint - Nudge users toward installing the optional Materialize agent skill.
Mirrors the
## Agent skillssection of the scaffoldedREADME.md. - prompt_
default_ ๐profile - Interactive nudge to pick a default profile right after scaffolding.
- run
mz-deploy new <name>โ create a new directory and scaffold into it.- scaffold ๐
- Common scaffolding logic shared by
newandinit.