Configuration

🚀Configuration

Recommended

Understand how the generated configuration file controls Custy's behavior.

Commandcusty init

📦Category

Initialization

🚀Quick Command

custy init

---

configurationcustomizationconfig.toml

---

Overview

One of the primary goals of custy init is to generate a project-specific configuration file.

Rather than requiring every command-line option to be supplied each time, Custy allows many behaviors to be configured once and reused automatically by future commands.

💡Project Configuration

The generated configuration belongs to your project, not to Custy itself.

This makes it easy for every contributor to share the same defaults simply by committing the configuration file to version control.

---

Configuration File

After initialization, the primary configuration file is located at:

Terminal

bash

.config/custy/config.toml

Future Custy commands automatically load this file whenever it exists.

---

What Can Be Configured?

✨Configuration Categories

Project

Define project-specific information such as the primary source directory used by Custy.

Initialization

Configure default behavior for initialization, including overwrite and confirmation settings.

Release

Configure release metadata such as the default author and release date handling.

Versioning

Define the preferred versioning strategy and default bump behavior used by release-related commands.

---

Configuration Philosophy

Custy is designed around the idea that project behavior should be customizable rather than hard-coded.

The generated configuration provides a central location where your team can define project preferences once instead of repeating the same command-line options for every operation.

This approach improves consistency while still allowing individual commands to override configuration values whenever necessary.

---

ℹ️Growing Configuration

The configuration file is intentionally organized into logical sections.

As Custy gains new capabilities, additional configuration groups may be added without changing the overall structure of the file.

---

Relationship with Command-Line Options

Command-line options always take precedence over configuration values.

When an option is omitted, Custy attempts to resolve the value from the project configuration before falling back to its built-in defaults.

This allows projects to define sensible defaults while still giving users the flexibility to override them when necessary.

---

What's Next?

Now that you understand how Custy is configured, continue to the Examples page to see common initialization scenarios and recommended usage patterns.