Options

🚀Options

Recommended

Learn about the command-line options supported by the backup command.

Commandcusty backup

📦Category

Backup

🚀Quick Command

custy backup commit

---

optionsbackupcli

---

Overview

The backup command accepts command-specific options that control how backup files are created.

Configuration values may also be resolved from your project's config.toml file.

💡Configuration First

Command-line options override configuration values for the current execution only.

If no option is supplied, Custy uses the project's configured value or its built-in default.

---

Available Options

⚙️Command Options

Available command-line options.

--backup-dir

Optional

---

Override the destination directory used for generated backup files.

DefaultConfigured backup directory

Examplecusty backup commit --backup-dir .config/custy/backups/custom

--keep

Optional

---

Specify how many backup files should be retained before older backups are pruned.

DefaultProject configuration

Examplecusty backup all --keep 20

--force-f

Optional

---

Create backup directories when necessary and continue without interactive confirmation.

Defaultfalse

Examplecusty backup tag --force

---

Option Resolution

When determining backup behavior, Custy resolves values in the following order.

1. Command-line options.
2. Project configuration (config.toml).
3. Custy's built-in defaults.

This allows projects to define sensible backup policies while still allowing individual executions to override specific settings.

---

ℹ️Global CLI Options

Global options such as --dry-run, --debug, and --log-level

are documented separately because they apply to every Custy command.

---

Backup Directories

The exact backup destination depends on the selected subcommand.

Typical destinations include dedicated directories for commit backups and tag backups.

These locations can be customized through the project configuration.

---

What's Next?

Continue to the Backup Files page to learn what Custy backs up, where those files are stored, how backup names are generated, and how old backups are managed.