Configuration File
Configuration File
Essential
Separate Custy's packaged initialization source from the editable configuration owned by your project.
Command
custy initCategory
Configuration
Quick Command
custy init [--mode config] [--ask | --force]Overview
Custy ships app/templates/config.toml inside the application package. During
initialization it copies that content to .config/custy/config.toml. Users
edit the project copy; they do not need access to the installed source file.
Ownership
Properties
| Property | Type | Description | Default | Required |
|---|---|---|---|---|
app/templates/config.toml | Application source | Packaged with Custy and used to create a fresh project configuration. Application upgrades may replace it. | - | No |
.config/custy/config.toml | Project-owned copy | Loaded by commands and intended for team-specific edits, review, and version control. | - | No |
app/templates/changelog/changelog.j2 | Application source | Packaged source for the default changelog layout. | - | No |
.config/custy/templates/changelog/changelog.j2 | Project-owned copy | Editable Jinja template loaded through the configured path. | - | No |
The current packaged and generated configuration files have the same logical TOML content. Their byte hashes can differ because of line-ending conversion.
Write Behavior
Workflow Timeline
1
Missing resource
Custy creates it from the packaged source.
2
Existing resource, normal mode
Custy preserves the project copy and skips replacement.
3
Existing resource with --ask
Custy asks before replacing an individual file.
4
Existing resource with --force
Custy replaces selected resources without prompting.
TOML Root and Loading
Required namespace shape
toml[tool.custy]
[tool.custy.project]
project_source = "auto"
[tool.custy.cli.execution]
dry_run = false- The central loader exposes values below
[tool.custy]. - Missing configuration is treated as an uninitialized project and loads an
empty mapping. Use
custy initwhen project-owned defaults are required. - Invalid TOML raises a configuration error.
- Relative paths are normally evaluated from the current working directory.
- A new Custy process reloads changes made to the file.
- Keep secret values out of project configuration. Credential policy and external token filenames may be configured there, but token contents belong in the external credential directory or an environment variable.