All Configuration Properties
All Configuration Properties
Exhaustive Index
Use full TOML paths to locate defaults, implementation status, and detailed guidance.
Command
[tool.custy.*]Category
Configuration
Quick Command
tool.custy.NAMESPACE.PROPERTYStatus legendâ
Active means current code applies the property. Optional means active but omitted or commented out in the generated file. Mismatch means the generated name or shape differs from active code. Loaded only means the resolver accepts it but the active output path does not use it. Reserved means generated without an active consumer. Experimental means unstable.
Project, Release, and Initialization
| Full path | Generated default | Status | Details |
|---|---|---|---|
tool.custy.project.project_source | "auto" | Active | Project |
tool.custy.release.author | "devalltect00" | Mismatch | Release |
tool.custy.release.include_date | true | Mismatch | Release |
tool.custy.initialization.force | false | Active | Initialization |
tool.custy.initialization.ask | false | Active | Initialization |
Commit Validation
| Full path | Generated default | Status | Details |
|---|---|---|---|
tool.custy.commit.validation.provider | "auto" | Active | Commit Validation |
tool.custy.commit.validation.require_tool | false | Active | Commit Validation |
Editor
| Full path | Generated default | Status | Details |
|---|---|---|---|
tool.custy.editor.prefer_environment | true | Active | Editor |
tool.custy.editor.allow_fallback | true | Active | Editor |
tool.custy.editor.candidates.windows | ["vscode", "notepad"] | Active | Editor |
tool.custy.editor.candidates.linux | ["micro", "nano", "vim", "vi"] | Active | Editor |
tool.custy.editor.candidates.macos | ["vscode", "micro", "nano", "vim", "vi"] | Active | Editor |
tool.custy.editor.candidates.container | ["micro", "nano", "vim", "vi"] | Active | Editor |
CLI: Versioning, Paths, and Templates
| Full path | Generated/default value | Status | Details |
|---|---|---|---|
tool.custy.cli.versioning.strategy | "semver" | Active | Versioning |
tool.custy.cli.versioning.bump | "auto" | Active | Versioning |
tool.custy.cli.versioning.date_format | %Y.%m.%d built-in | Optional | Versioning |
tool.custy.cli.paths.version_file | "auto" | Active | Paths |
tool.custy.cli.templates.file.changelog | .config/custy/templates/changelog/changelog.j2 | Active | Template Files |
tool.custy.cli.templates.file.commit_message | .config/custy/templates/commit-message.txt | Active | Template Files |
tool.custy.cli.templates.file.tag_message | .config/custy/templates/tag-message.txt | Active | Template Files |
tool.custy.cli.templates.directory.backups_commit | .config/custy/templates/backups/commit | Active | Template Directories |
tool.custy.cli.templates.directory.backups_tag | .config/custy/templates/backups/tag | Active | Template Directories |
CLI: Execution and Push
| Full path | Generated default | Status | Details |
|---|---|---|---|
tool.custy.cli.execution.dry_run | false | Active | Execution |
tool.custy.cli.execution.force_commit | false | Active | Execution |
tool.custy.cli.execution.force_tag | false | Active | Execution |
tool.custy.cli.execution.skip_checks | false | Mismatch | Execution |
tool.custy.cli.execution.no_debug | true | Active | Execution |
tool.custy.cli.execution.auto_stage | false | Active | Execution |
tool.custy.cli.execution.stage_mode | "all" | Active | Execution |
tool.custy.cli.execution.check_cz | false | Active | Execution |
tool.custy.cli.push.all_remote | true | Active | Push |
tool.custy.cli.push.skip_tag | false | Active | Push |
tool.custy.cli.push.sync_backup | false | Active | Push |
CLI: Changelog, Cleanup, and Workflow
| Full path | Generated/default value | Status | Details |
|---|---|---|---|
tool.custy.cli.changelog.force_generation | false | Active | Changelog Command |
tool.custy.cli.cleanup.backup.type | "all" | Active | Backup Cleanup |
tool.custy.cli.cleanup.backup.keep | 10 | Active | Backup Cleanup |
tool.custy.cli.cleanup.branch.include_prefixes | [] | Active | Branch Cleanup |
tool.custy.cli.cleanup.branch.merge_status | "merged" | Active | Branch Cleanup |
tool.custy.cli.cleanup.branch.max_age | unset | Optional | Branch Cleanup |
tool.custy.cli.cleanup.branch.before | unset | Optional | Branch Cleanup |
tool.custy.cli.workflow.enforce | false | Experimental | Workflow |
tool.custy.cli.workflow.check_transition | false | Experimental | Workflow |
tool.custy.cli.workflow.sync_backup | false | Experimental | Workflow |
Logging
| Full path | Generated default | Status | Details |
|---|---|---|---|
tool.custy.logging.level | "INFO" | Active | Console |
tool.custy.logging.markup | true | Active | Console |
tool.custy.logging.rich_tracebacks | true | Active | Console |
tool.custy.logging.show_time | false | Active | Console |
tool.custy.logging.show_level | false | Active | Console |
tool.custy.logging.console_format | "%(message)s" | Active | Console |
tool.custy.logging.file.level | "DEBUG" | Active | File |
tool.custy.logging.file.log_dir | "logs" | Active | File |
tool.custy.logging.file.log_file | "custy.log" | Active | File |
tool.custy.logging.file.max_bytes | "10MB" | Active | File |
tool.custy.logging.file.backup_count | 5 | Active | File |
tool.custy.logging.file.file_format | timestamp, level, name, message | Active | File |
Changelog: Collection, Pending, Cleaning, and Releases
| Full path | Generated default | Status | Details |
|---|---|---|---|
tool.custy.changelog.core.ignore_merge_commits | true | Active | Core |
tool.custy.changelog.core.ignore_types | ["chore"] | Active | Core |
tool.custy.changelog.pending_commit.enabled | true | Active | Pending Commit |
tool.custy.changelog.pending_commit.generation | "regenerate" | Loaded only | Pending Commit |
tool.custy.changelog.pending_commit.placement | "before" | Loaded only | Pending Commit |
tool.custy.changelog.cleaning.remove_separators | ["---"] | Active | Cleaning |
tool.custy.changelog.cleaning.remove_headers | false | Active | Cleaning |
tool.custy.changelog.cleaning.remove_hash_lines | false | Active | Cleaning |
tool.custy.changelog.cleaning.remove_release_summary | false | Active | Cleaning |
tool.custy.changelog.cleaning.remove_metadata | false | Active | Cleaning |
tool.custy.changelog.cleaning.remove_keywords | 3 phrases | Active | Cleaning |
tool.custy.changelog.release.extract_bullets_only | true | Active | Releases |
tool.custy.changelog.release.fallback_to_subject | true | Active | Releases |
tool.custy.changelog.release_behavior."VERSION".hidden | false | Active dynamic key | Releases |
tool.custy.changelog.release_behavior."VERSION".title_only | false | Active dynamic key | Releases |
tool.custy.changelog.release_behavior."VERSION".custom_message | unset | Active dynamic key | Releases |
tool.custy.changelog.links.repository | "" | Active | Links |
tool.custy.changelog.links.enable_compare | false | Active | Links |
Changelog: Rendering
| Full path | Default | Status |
|---|---|---|
tool.custy.changelog.render.show_title | true | Active |
tool.custy.changelog.render.show_description | true | Active |
tool.custy.changelog.render.show_release_status | true | Active |
tool.custy.changelog.render.show_summary | true | Active |
tool.custy.changelog.render.show_promoted_from | true | Active |
tool.custy.changelog.render.show_compare_link | true | Active |
tool.custy.changelog.render.group_by_scope | true | Active |
tool.custy.changelog.render.collapse_generic_scopes | true | Active |
tool.custy.changelog.render.generic_scopes | 8 values | Active |
tool.custy.changelog.render.deduplicate | true | Active |
tool.custy.changelog.render.show_empty_sections | false | Loaded only |
tool.custy.changelog.render.show_empty_groups | false | Active |
tool.custy.changelog.render.show_empty_scopes | false | Active |
tool.custy.changelog.render.show_empty_metadata | false | Loaded only |
tool.custy.changelog.render.show_empty_tags | false | Active |
tool.custy.changelog.render.show_metadata | true | Loaded only |
tool.custy.changelog.render.show_tags | true | Active |
tool.custy.changelog.render.show_contributors | false | Loaded only / future |
tool.custy.changelog.render.show_statistics | false | Loaded only / future |
tool.custy.changelog.render.bullet | "-" | Active |
tool.custy.changelog.render.indent | 0 | Active |
tool.custy.changelog.render.blank_lines_between_releases | 2 | Loaded only |
tool.custy.changelog.render.blank_lines_between_commit_groups | 1 | Loaded only |
tool.custy.changelog.render.sort_groups | false | Active |
tool.custy.changelog.render.sort_scopes | true | Active |
tool.custy.changelog.render.sort_items | false | Active |
tool.custy.changelog.render.show_section_icons | true | Active |
tool.custy.changelog.render.show_footer | false | Active |
See Rendering for individual behavior and examples.
Changelog: Breaking, Mappings, and Advanced
| Full path | Generated default | Status | Details |
|---|---|---|---|
tool.custy.changelog.breaking.enabled | true | Active | Breaking |
tool.custy.changelog.breaking.keywords | 3 values | Active | Breaking |
tool.custy.changelog.breaking.label | â ī¸ Breaking Changes | Active config | Breaking |
tool.custy.changelog.scope_map.<scope> | 9 generated entries | Active dynamic mapping | Mappings |
tool.custy.changelog.type_map.<type> | 16 generated entries | Active dynamic mapping | Mappings |
tool.custy.changelog.advanced.auto_detect_type | false | Experimental / loaded only | Advanced |
tool.custy.changelog.advanced.detect_breaking_changes | false | Experimental / loaded only | Advanced |
tool.custy.changelog.advanced.smart_formatting | false | Experimental / loaded only | Advanced |
Every generated scope and type entry is listed individually on the Mappings page.
Git
| Full path | Generated/default value | Status | Details |
|---|---|---|---|
tool.custy.git.default_remote | "origin" | Active | Remotes |
tool.custy.git.auto_push | true | Reserved | Push Strategy |
tool.custy.git.main_remotes | ["origin"] | Active | Remotes |
tool.custy.git.backup_remotes | [] built-in | Optional | Remotes |
tool.custy.git.push_to | "main" | Active | Push Strategy |
tool.custy.git.credentials.mode | "native" | Active | Git Credentials |
tool.custy.git.credentials.container_only | true | Active | Git Credentials |
tool.custy.git.credentials.source_order | ["file", "environment"] | Active | Git Credentials |
tool.custy.git.credentials.interactive_fallback | true | Active | Git Credentials |
tool.custy.git.credentials.fail_non_interactive | true | Active | Git Credentials |
tool.custy.git.credentials.github.enabled | false | Active | Git Credentials |
tool.custy.git.credentials.github.username | "x-access-token" | Active | Git Credentials |
tool.custy.git.credentials.github.token_file | "github.token" | Active | Git Credentials |
tool.custy.git.credentials.github.token_env | "CUSTY_GITHUB_TOKEN" | Active | Git Credentials |
tool.custy.git.credentials.gitlab.enabled | false | Active | Git Credentials |
tool.custy.git.credentials.gitlab.username | "oauth2" | Active | Git Credentials |
tool.custy.git.credentials.gitlab.token_file | "gitlab.token" | Active | Git Credentials |
tool.custy.git.credentials.gitlab.token_env | "CUSTY_GITLAB_TOKEN" | Active | Git Credentials |
tool.custy.git.hooks.mode | "auto" | Active | Git Commit Hooks |