Requirements

🚀Requirements

Recommended

Understand the prerequisites required before validating a project.

Commandcusty validate

📦Category

Validation

🚀Quick Command

custy validate

---

requirementsvalidationgit

---

Overview

Before running custy validate, your project should satisfy a few basic requirements.

Most validation failures occur because one or more of these prerequisites are missing rather than because of a problem with Custy itself.

💡Not Every Requirement Is Mandatory

Some validation checks depend on your project configuration and workflow.

Commitizen is optional unless the commit validation provider or version strategy explicitly requires it. Auto mode safely uses Custy's built-in validator when Commitizen is not configured or installed.

---

Prerequisites

📌Required Environment

🌿Git Repository

Required

The current directory should already be initialized as a Git repository.

⚙️Custy Configuration

Required

Running custy init beforehand is highly recommended so that configuration and template files are available.

🌐Git Remote

Required

The configured Git remote should already exist if your workflow requires remote validation.

📁Project Resources

Required

Version files and template files should exist in the configured locations.

---

Recommended Preparation

Before running validation, it is recommended that you:

• Open the project's root directory.
• Verify that Git has been initialized.
• Review your .config/custy/config.toml configuration.
• Stage changes if you intend to continue with a commit workflow.
• Confirm that required template files have been generated.

These steps reduce the likelihood of validation failures.

---

ℹ️Automatic Validation

If you normally execute workflows through custy run, you usually do not need to run custy validate manually because validation is performed automatically before the workflow continues.

---

What Is Not Required?

Validation does not require:

• Existing Git commits.
• Existing Git tags.
• A published release.
• A remote push.

The command verifies readiness for future operations rather than checking project history.

---

What's Next?

The next page explains the command syntax and the available invocation forms for running project validation.