Getting Started
Getting Started
Recommended
Install Custy, prepare an existing Git repository, and preview your first development pipeline safely.
Command
custyCategory
Onboarding
Quick Command
custy COMMAND [OPTIONS]Overviewâ
This guide takes you from installation to a reviewed pipeline preview. You will install Custy, generate project-specific resources, validate the repository, and inspect a development pipeline before allowing it to change files or Git history.
Choose Your Setup Path
Every supported path exposes the same public CLI; choose the installation source and environment that fit your project.
Setup Options
Native User Installation
Install a normal runtime copy from a reviewed source checkout, release artifact, or Git revision.
Contributor Installation
Use an editable source installation with the
dev dependency group when working on Custy itself.Docker Environment
Build Custy's production or development image locally and mount the intended project at
/workspace.Quick Start
Initialize and validate an existing repository, then preview the Dev profile without applying changes.
Recommended Learning Path
From Installation to First Preview
1
Install Custy
Use a reviewed native Python installation or a locally built Docker image.
2
Prepare the Repository
Open the project root and confirm that Git tracks the intended repository.
3
Initialize Custy Resources
Run
custy init, then review the generated configuration, templates, and version file.4
Validate Readiness
Run
custy validate and resolve missing files, remotes, or repository prerequisites.5
Preview a Pipeline
Use
custy --dry-run run dev before allowing commit or push side effects.The Short Version
Safe onboarding sequence
bash# From the root of an existing Git repository
custy --version
custy init
git status --short
custy validate
custy --dry-run run devThe dry run is the end of the basic onboarding sequence. Continue to normal execution only after you understand the selected profile's file, Git, and remote side effects.