Examples

🚀Examples

Recommended

Learn common ways to initialize a project using Custy.

Commandcusty init

📦Category

Initialization

🚀Quick Command

custy init

---

examplesbest practicesinitialization

---

Overview

The following examples demonstrate common ways to initialize a project.

Most users only need the default initialization, while advanced workflows can use initialization modes and overwrite options to customize the generated resources.

💡Getting Started

If this is your first time using Custy, begin with the default initialization.

---

Common Examples

📝Examples

Practical command examples.

Initialize a Project

Generate the complete Custy project workspace using the default initialization mode.

CLI

custy init

---

✅Expected Result

Creates the default configuration, templates, directory structure, and recursively merged example resources.

---

💡Notes

Existing files are preserved by default, while missing nested examples can still be added.

Generate Configuration Only

Create only the Custy configuration file.

CLI

custy init --mode config

---

✅Expected Result

Generates .config/custy/config.toml without creating templates or example resources.

---

💡Notes

Useful when you only need project configuration and plan to create templates later.

Generate Templates Only

Generate only the default template resources.

CLI

custy init --mode templates

---

✅Expected Result

Creates the default commit, tag, and changelog templates.

---

💡Notes

Ideal for regenerating templates without modifying other project resources.

Generate Example Resources

Generate only the example message templates.

CLI

custy init --mode examples

---

✅Expected Result

Recursively creates or merges the commit-message and tag-message example trees.

---

💡Notes

Existing example files are preserved; missing files and nested directories are added.

Overwrite Existing Resources

Replace existing generated resources without prompting.

CLI

custy init --force

---

✅Expected Result

Existing selected files, including nested example files, are overwritten immediately.

---

💡Notes

Directories are merged rather than replaced. Use carefully if configuration, templates, or examples were customized.

Prompt Before Overwriting

Ask for confirmation before replacing existing resources.

CLI

custy init --ask

---

✅Expected Result

Custy prompts before supported individual generated files are overwritten.

---

💡Notes

Packaged examples do not prompt per file; they preserve existing files and copy missing files.

💡Safely Refresh the Example Catalog

Run custy init --mode examples after upgrading Custy to add newly packaged examples without replacing examples you already customized. Add --force only when you intentionally want packaged content to replace existing example files.

---

Typical First-Time Setup

For a new project, the recommended workflow is:

1. Run custy init.
2. Review the generated configuration.
3. Customize templates if necessary.
4. Commit the generated resources to version control.

This allows every contributor to share the same project configuration from the beginning.

---

ℹ️Public Command

Project initialization is exposed as custy init. The current public Run argument does not accept an init profile.

---

What's Next?

After becoming familiar with the initialization process, continue to the Output page to understand the messages and results produced by the command.