Examples

🚀Examples

Recommended

Learn how to remove obsolete backup files using common Backup Cleanup scenarios.

Commandcusty cleanup backups

📦Category

Maintenance

🚀Quick Command

custy cleanup backups

---

examplescleanupbackup

---

Overview

The following examples demonstrate common ways to clean obsolete backup files.

Depending on your project's configuration, Backup Cleanup can remove commit backups, tag backups, or both while preserving the configured number of recent backups.

---

Common Examples

📝Examples

Practical command examples.

Clean All Backup Files

Remove obsolete backup files using the configured cleanup settings.

CLI

custy cleanup backups

---

✅Expected Result

Old backup files are removed while the configured number of newest backups is preserved.

Clean Commit Backups Only

Remove obsolete commit message backups only.

CLI

custy cleanup backups --type commit

---

✅Expected Result

Only commit message backup files are considered during cleanup.

Clean Tag Backups Only

Remove obsolete tag message backups only.

CLI

custy cleanup backups --type tag

---

✅Expected Result

Only tag message backup files are cleaned.

---

Retention Examples

📝Examples

Practical command examples.

Keep Five Backups

Preserve only the five newest backup files.

CLI

custy cleanup backups --keep 5

---

✅Expected Result

Custy removes backup files older than the five newest backups.

Keep Twenty Backups

Retain a larger backup history.

CLI

custy cleanup backups --keep 20

---

✅Expected Result

Custy preserves the newest twenty backups before removing older files.

---

ℹ️Public invocation

Use custy cleanup backups. Public release profiles can include internal backup cleanup automatically, but the internal profile name is not a public Run value.

---

Global Options

Global options are specified before the command.

Examples include:

📝Examples

Practical command examples.

Preview Cleanup

See what would happen without deleting backup files.

CLI

custy --dry-run cleanup backups

---

✅Expected Result

Displays the cleanup operation without removing any files.

Debug Cleanup

Run Backup Cleanup with additional diagnostic information.

CLI

custy --debug cleanup backups

---

✅Expected Result

Executes Backup Cleanup while producing additional debug output.

---

💡Usually Runs Automatically

Backup Cleanup is included in several Custy workflow pipelines.

In many projects you may rarely need to execute it manually because workflow execution already performs backup maintenance automatically.

---

What's Next?

Continue to the Output page to learn how Custy reports the results of a Backup Cleanup operation.