Examples

🚀Examples

Stable

Use practical commit-profile patterns for previews, staging control, version files, and intentional empty commits.

Commandcusty commit

📦Category

Git Operations

🚀Quick Command

custy commit [OPTIONS]

---

examplesstagingdry-run

---

Overview

Preview the complete profile before allowing it to edit files, stage changes, and create local Git history.

💡Start with dry-run

Use custy --dry-run commit when working in a new repository or after changing commit configuration.

---

Common Examples

📝Examples

Practical command examples.

Run the configured commit profile

Prepare artifacts, generate the changelog, stage, and commit with project settings.

CLI

custy commit

---

✅Expected Result

A reviewed commit is created locally when every stage succeeds.

Preview before changing the repository

Inspect the planned pipeline through the global dry-run mode.

CLI

custy --dry-run commit

---

💡Notes

Check output carefully because the normal profile has broad side effects.

Stage tracked changes only

Use Git's update-style staging for tracked modifications and deletions.

CLI

custy commit --auto-stage --stage-mode update

Use a dedicated version file

Override the configured version path for one run.

CLI

custy commit --version-file src/package_version.py

Permit an empty commit

Allow the commit stage to continue when an empty commit is intentional.

CLI

custy commit --allow-empty-commit

---

💡Notes

Use this only for a deliberate workflow requirement.

---

⚠️Empty commits are deliberate exceptions

Do not use --allow-empty-commit to bypass an unrelated validation, staging, or configuration error.