Skip to main content

Module new_project

Module new_project 

Source
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ยง

ScaffoldOpts
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 skills section of the scaffolded README.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 new and init.