Options

🚀Command Options

Recommended

Learn how each command-line option changes the initialization process.

Commandcusty init

📦Category

Initialization

🚀Quick Command

custy init [OPTIONS]

---

optionsconfigurationinitialization

---

Overview

The custy init command provides a small set of options that control what is initialized and how existing files are handled.

Most projects can be initialized successfully using the default behavior.

Use these options only when you need more control over the initialization process.

💡Default Behavior

Running custy init without additional options initializes the project using the default all mode.

---

Available Options

⚙️Command Options

Available command-line options.

--mode-m

Optional

---

Select which project resources should be initialized.

Defaultall

Examplecusty init --mode templates

--force-f

Optional

---

Overwrite existing files without prompting.

Defaultfalse

Examplecusty init --force

--ask-a

Optional

---

Prompt before overwriting supported generated files. Packaged examples are merged without per-file prompts.

Defaultfalse

Examplecusty init --ask

---

Initialization Modes

The --mode option determines which resources Custy generates.

Mode	Description
all	Generate configuration, templates, and example resources.
all_no_examples	Generate configuration and templates without examples.
config	Generate only the project configuration files.
templates	Generate only the default templates.
examples	Generate only the example resources.

For most projects, all is the recommended choice because it prepares the entire project workspace in a single step.

---

Overwrite Behavior

The --force and --ask options control how Custy behaves when generated resources already exist.

--force

Use this option when you want Custy to overwrite existing selected files without requesting confirmation. For packaged examples, the overwrite applies recursively to files while the existing directory tree is merged in place.

This is useful when intentionally regenerating configuration or template files.

--ask

Use this option when you prefer reviewing supported generated-file overwrites before they happen. The prompt applies to individually generated resources such as configuration and active templates. Packaged example files use merge behavior instead: existing examples are preserved and missing examples are copied without prompting.

This is particularly helpful when working with an existing project that already contains customized templates.

---

⚠️Use Force Carefully

If your project contains customized configuration or template files, --force may replace them with newly generated versions.

Review project changes before committing regenerated files.

ℹ️Existing Example Directories Are Reused

An existing .config/custy/templates/examples/ directory does not block the copy. Custy walks the packaged tree recursively and decides at each file: preserve it normally, or overwrite it when --force is active.

---

Configuration Integration

The values for --force and --ask can also be supplied through your Custy configuration.

When an option is not explicitly provided on the command line, Custy resolves the value from the project's configuration before falling back to its built-in defaults.

This allows teams to define consistent initialization behavior without requiring every user to specify the same options repeatedly.

---

What's Next?

Now that you understand the available options, continue to the Workflow page to learn what happens internally when the initialization process begins.