Skip to main content

Requirements

Requirements

Recommended

Understand the prerequisites before removing obsolete backup files.

Commandcusty cleanup backups

Category

Maintenance

Quick Command

custy cleanup backups
cleanupbackuprequirements

Overview​

Backup Cleanup operates on backup files previously created by Custy.

Before removing old backups, ensure that backup files already exist and that your project configuration reflects the desired retention policy.

Prerequisites

Required Environment

Initialized Project

Required
The project should already be initialized so that Custy's backup directories and configuration are available.

Existing Backup Files

Required
Backup Cleanup only removes files that already exist inside the configured backup directories.

Project Configuration

Required
Cleanup behavior, backup type, and retention count are resolved from your project's configuration whenever available.

Writable Backup Directory

Required
Custy must be able to inspect and remove files from the configured backup directories.

Recommended Preparation

Before running Backup Cleanup, consider the following:

  • Verify that backup files exist.
  • Review the configured backup retention count.
  • Confirm that important backup files are no longer needed.
  • Review your project's cleanup configuration.

Following these recommendations helps ensure that only obsolete backup files are removed.

Configuration

Backup Cleanup behavior is controlled through your project's config.toml.

Typical settings include:

  • Cleanup target.
  • Backup retention count.
  • Backup directories.

Command-line options may temporarily override these configuration values for the current execution.

What Is Not Required?

Backup Cleanup does not require:

  • staged Git changes,
  • commits,
  • branches,
  • tags,
  • remote repositories.

Only the presence of backup files is required.

What's Next?

Continue to the Syntax page to learn how to remove commit backups, tag backups, or both using the available cleanup modes.