Skip to main content

Requirements

Requirements

Recommended

Understand the prerequisites for creating Custy template backups.

Commandcusty backup

Category

Backup

Quick Command

custy backup commit
requirementsbackuptemplates

Overview​

The backup command operates on files generated or managed by Custy.

Before creating backups, ensure that the required template files already exist within your project.

Prerequisites

Required Environment

Initialized Project

Required
The project should already contain Custy's generated configuration and template files.

Template Files

Required
Commit message and tag message templates should exist before they can be backed up.

Writable Backup Directory

Required
Custy must be able to create backup files inside the configured backup directory.

Project Configuration

Required
Backup locations and related settings are resolved from your project's configuration whenever available.

Recommended Preparation

Before creating backups, it is recommended to:

  • Run custy init if the project has not been initialized.
  • Review your project's config.toml configuration.
  • Verify that the template files you want to back up already exist.
  • Ensure the configured backup directory is writable.

These steps help ensure backups are created successfully.

What Is Not Required?

The backup command does not require:

  • staged Git changes,
  • existing Git tags,
  • remote repositories,
  • published releases.

It only requires the files that will be backed up.

What's Next?

Continue to the Syntax page to learn how to create commit, tag, and combined backups using the available backup subcommands.