Generated Files

🚀Generated Files

Recommended

Understand the project resources created during initialization.

Commandcusty init

📦Category

Initialization

🚀Quick Command

custy init

---

configurationtemplatesgenerated files

---

Overview

Running custy init creates a project-specific workspace inside your repository.

These resources become part of your project and can be customized to match your team's workflow.

💡Version Control

The generated files are intended to be committed to your repository so that every contributor uses the same Custy configuration and templates.

---

Generated Resources

✨Resources Created

Configuration

Generates the primary.config/custy/config.tomlconfiguration file.

Templates

Creates the default commit, tag, and changelog templates used by future Custy workflows.

Examples

Optionally generates example message templates for experimentation and customization.

Directory Structure

Creates the directory layout expected by future Custy commands.

---

Project Structure

After a successful initialization, your project contains a structure similar to the following.

Terminal

bash

.config/
└── custy/
  ├── config.toml
  └── templates/
      ├── backups/
      │   ├── commit/
      │   └── tag/
      ├── changelog/
      │   └── changelog.j2
      ├── examples/
      │   ├── commit_message/
      │   │   ├── since_custy_v1/
      │   │   └── since_custy_v2/
      │   └── tag_message/
      │       ├── since_custy_v1/
      │       └── since_custy_v2/
      ├── commit-message.txt
      └── tag-message.txt

ℹ️Project-aware version initialization

custy init no longer assumes that every project has app/. Python projects without existing version metadata may receive __version__.py under the detected source directory. Existing Python or Node.js metadata is preserved, and Node.js or generic projects do not receive an artificial Python version file.

ℹ️Recursive Example Merge

When all or examples mode runs again, Custy merges the complete packaged example tree into this directory. Missing nested directories and files are added. Existing files are preserved unless --force is enabled; the example directories themselves are not replaced.

---

Customization

All generated resources belong to your project rather than Custy itself.

This means you are free to:

• Modify template contents.
• Adjust configuration values.
• Commit the generated files.
• Share them with your development team.

Future Custy commands automatically use these customized resources whenever they are available.

---

ℹ️Initialization Modes

The exact resources created depend on the selected initialization mode.

For example, running with the examples mode generates only example resources, while config creates only the project configuration.

---

What's Next?

Now that you understand the generated project structure, continue with the Configuration page to learn how each setting in config.toml affects Custy's behavior.