Syntax

🚀Syntax

Recommended

Learn how to remove obsolete backup files using Custy's Backup Cleanup command.

Commandcusty cleanup backups

📦Category

Maintenance

🚀Quick Command

custy cleanup backups

---

cleanupbackupsyntax

---

Overview

Backup Cleanup removes obsolete backup files from your project's backup directories.

The command supports cleaning:

• commit message backups,
• tag message backups,
• or both.

The cleanup behavior is determined by command-line options and project configuration.

---

Basic Syntax

🚀Command Syntax

Available command syntax and usage examples.

Backup Cleanup

Remove obsolete backup files using the configured cleanup settings.

bash

custy cleanup backups

---

ℹ️Public invocation

Use custy cleanup backups. Backup cleanup is reused internally by larger profiles, but cleanup_backups is not accepted as a public Run argument.

---

Cleanup Targets

Depending on the selected cleanup type, Custy may remove:

• commit message backups,
• tag message backups,
• both backup categories.

The cleanup target can be selected explicitly or resolved from your project's configuration.

---

Global Options

Like every Custy command, Backup Cleanup supports the global CLI options.

Examples include:

Terminal

bash

custy --dry-run cleanup backups

Terminal

bash

custy --debug cleanup backups

Terminal

bash

custy --log-level DEBUG cleanup backups

Global options are always specified before the command name.

---

💡Configuration First

When cleanup options are not supplied on the command line, Custy resolves the effective cleanup configuration from your project's config.toml.

This allows projects to define consistent cleanup behavior while still allowing temporary command-line overrides when needed.

---

Exit Behavior

Backup Cleanup finishes after processing the configured backup directories.

Depending on the current project state, the command may:

• remove obsolete backup files,
• determine that no cleanup is necessary,
• report the cleanup summary.

Successful completion does not modify your Git repository.

---

What's Next?

Continue to the Options page to learn how cleanup targets and retention behavior can be customized for individual executions.