Requirements

🚀Requirements

Recommended

Review the recommended prerequisites before preparing a project for use with Custy.

Commandcusty init

📦Category

Initialization

🚀Quick Command

custy init

---

requirementssetupproject initialization

---

Overview

Before running custy init, make sure the project and your development environment are ready.

Although Custy provides sensible defaults and is designed to work with minimal setup, meeting the following recommendations will provide the best experience and make future workflows easier to manage.

💡Recommended

Most projects only need to run custy init once. After initialization, the generated configuration and template files can be customized to match your team's workflow.

---

Recommended Requirements

📌Requirements

Existing Project

Recommended

Run the command from the root directory of an existing software project.

Write Permission

Required

Custy creates configuration files and directories inside your project.

Custy Installed

Required

Use a reviewed native installation or a Custy image built locally from the current Dockerfile.

Git Repository

Recommended

Initialization can write resources without Git, but Custy's main validation, changelog, version, commit, tag, push, and pipeline workflows require it.

---

Supported Installation Methods

Choose the reviewed installation source and environment that best fit your project:

• a normal Python installation from a source checkout;
• a wheel or source distribution attached to a selected release;
• a pinned Git tag or commit;
• an editable source installation for Custy contributors; or
• a Docker image built locally from Custy's Dockerfile.

See Installation for native methods and Docker for the container requirements.

The command behaves the same regardless of how Custy is installed.

---

Example

The following example initializes the current project.

Terminal

bash

custy init

If you built the documented local production image, mount the intended project root at /workspace:

Terminal

bash

docker run -it --rm   -v "<project>:/workspace"   -w /workspace   custy-prod:latest   init

The image includes Git, Python 3.14, pip, and Make. Host Git is not required for this container invocation, but the mounted project must include its .git directory before later Git-based Custy commands can use it.

---

ℹ️Project Safety

Running custy init prepares your project by generating configuration and template files. It does not create commits, modify Git history, or execute release workflows.

---

What Happens Next?

Once these requirements are satisfied, continue with the syntax documentation to learn about the available initialization modes and command options.