Skip to main content

Initialization

Initialization

Active

Choose safe project defaults for preserving, prompting, or replacing generated resources.

Command[tool.custy.initialization]

Category

Configuration

Quick Command

custy init [--mode MODE] [--force | --ask]

scaffoldingoverwriteprompts

Properties

Properties

PropertyTypeDescriptionDefaultRequired
forceBooleanOverwrite existing selected files without confirmation, including files inside nested example directories. Directories are merged rather than replaced. An explicit CLI force choice wins.falseNo
askBooleanPrompt before replacing supported individual generated files. Packaged example files use merge behavior without per-file prompts. Declining preserves the prompted file.falseNo
Safe defaults
toml
[tool.custy.initialization]
force = false
ask = false

Example Directory Behavior

The all and examples modes walk packaged examples recursively. If the destination already exists, Custy adds missing nested directories and files instead of skipping the whole example tree. Existing files are preserved by default and overwritten only when effective force behavior is enabled.

Modes and Scope

The mode remains a CLI choice rather than a generated configuration property: all, all_no_examples, config, templates, or examples. When omitted, the resolver uses all.

Continue