Workflow

🚀Initialization Workflow

Recommended

Understand the sequence of operations performed when initializing a project with Custy.

Commandcusty init

📦Category

Initialization

🚀Quick Command

custy init

---

workflowinitializationproject setup

---

Overview

Running custy init prepares a project by generating the resources that Custy uses during future operations.

Rather than executing Git workflows immediately, the command creates a customizable project workspace that future commands can reuse.

💡Safe Operation

The initialization workflow does not create commits, tags, releases, or modify your Git history.

Its only responsibility is preparing the project for future Custy operations.

---

Workflow Timeline

🕒Initialization Timeline

High-level sequence of operations performed by the initialization workflow.

1

Resolve Options

Determine the effective initialization settings by combining command-line arguments, project configuration, and built-in defaults.

completed

2

Prepare Initialization

Build the initialization context and determine which resources need to be generated.

completed

3

Generate Resources

Create configuration files, templates, and optional example resources according to the selected mode.

completed

4

Handle Existing Files

Preserve or overwrite generated files according to their resource type, force behavior, and supported interactive confirmation settings.

completed

5

Complete Initialization

Finish the initialization process and prepare the project for future Custy commands.

completed

---

Workflow Stages

1

Resolve Initialization Settings

Determine the effective initialization mode by combining command-line arguments, project configuration, and Custy's built-in defaults.

completed

2

Build the Initialization Context

Prepare the internal execution context that will be shared by every generation step during initialization.

completed

3

Generate Project Resources

Generate the selected project resources, including configuration files, templates, and optional nested example resources depending on the chosen initialization mode.

completed

4

Merge Packaged Examples

Walk the packaged example tree recursively. Add missing directories and files, preserve existing example files by default, or overwrite those files when force behavior is enabled.

completed

5

Finalize Initialization

Complete the initialization process and prepare the project for subsequent Custy commands.

completed

---

ℹ️Designed for Reuse

The generated configuration and templates become part of your project.

They can be edited, committed to version control, and shared with other developers working on the same repository.

Running init again is additive for packaged examples by default: new nested examples are copied while existing example files remain unchanged.

---

What's Next?

The next page explains every file and directory created by the initialization workflow.