Paths and Files

🚀Paths and Files

Default Path Index

Locate the project-owned files Custy reads, writes, backs up, logs, and initializes.

Command.config/custy/

📦Category

Reference

🚀Quick Command

project root / relative path

---

configurationtemplatesbackupsoutputs

---

⚙️

Project Config

.config/custy/config.toml

🏷️

Primary Output

CHANGELOG.md

🐍

Default Version

app/__version__.py

📄

Default Log

logs/custy.log

Project-Owned Paths

📋Active Defaults

Property	Type	Description	Default	Required
.config/custy/config.toml	TOML	Project-owned configuration loaded from the current working tree.	-	No
.config/custy/templates/changelog/changelog.j2	Jinja template	Template used by ChangelogGenerator to render the complete Markdown document.	-	No
.config/custy/templates/commit-message.txt	Text	Editable commit-message source and optional pending changelog content.	-	No
.config/custy/templates/tag-message.txt	Text	Editable annotated-tag message source.	-	No
.config/custy/templates/backups/commit/	Directory	Default timestamped commit-message backup destination.	-	No
.config/custy/templates/backups/tag/	Directory	Default timestamped tag-message backup destination.	-	No
app/__version__.py	Python source	Generated and configured default version file. Initialization may select the detected project-source directory or fall back to src/__version__.py.	-	No
CHANGELOG.md	Markdown	Fixed active changelog output path in the project root.	-	No
logs/custy.log	Rotating log	Built-in log path; both directory and filename can be changed through tool.custy.logging.file.	-	No

---

Initialization Directories

Depending on the selected Init mode, Custy can create:

• .config/custy/
• .config/custy/templates/
• .config/custy/templates/backups/commit/
• .config/custy/templates/backups/tag/
• .config/custy/templates/changelog/
• .config/custy/templates/examples/commit_message/
• .config/custy/templates/examples/tag_message/

The packaged sources under app/templates/ belong to the installed Custy package. Initialization copies or renders those resources into the user's project; users should customize the project-owned copies instead of editing an installed package.

---

Resolution Rules

• Run Custy from the intended project root. Most default paths are relative to the current working directory.
• tool.custy.project.project_source is converted to an absolute path and must exist as a directory when the shared project-source constant is imported.
• CLI path inputs normally override configuration, which overrides a built-in default.
• The version-file path is configurable under tool.custy.cli.paths.version_file.
• Template and backup paths are configurable under tool.custy.cli.templates.file and .directory.
• The active changelog destination is CHANGELOG.md; the template path is configurable, but this output filename is not currently exposed as a normal project property.

---

⚠️Treat force initialization as replacement

Project-owned paths may contain customized content. Preview the Init plan and review the overwrite policy before using custy init --force; keep an external backup for configuration or templates that cannot be recreated.

ℹ️Current tag-backup path limitation

The tag-backup workflow resolves a configurable tag backup directory, but one active engine call still passes the built-in tag-backup constant to the file writer. Verify the actual destination before depending on a custom tag backup directory.

---

Continue

🚀Related Commands

Commands commonly used together with this command.

Generated Files

Review which Init mode creates each project resource.

Configuration File

Understand project ownership and safe replacement.

Template Files

Configure changelog, commit-message, and tag-message paths.

Logging Files

Configure log path, level, rotation size, count, and format.