Skip to main content

Syntax

Command Syntax

Recommended

Understand the supported invocation patterns for initializing a project with Custy.

Commandcusty init

Category

Initialization

Quick Command

custy init

syntaxclicommand

Overview​

The custy init command is the public interface for project initialization.


Direct Command

Command Syntax

Available command syntax and usage examples.

Initialize a Project

Initialize the current project using the default configuration.

bash
custy init
Terminal
bash
custy init

This is the simplest and most commonly used way to initialize a project.


Docker

After building custy-prod:latest from Custy's production Docker target, invoke the command against the intended mounted project.

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

See the Docker setup guide for the build command, host requirements, workspace-mount behavior, and Git credential considerations.



What's Next?

Now that you understand the command syntax, continue with the Options page to learn how each command-line option affects project initialization.