Skip to main content

Quick Start

Quick Start

Recommended

Prepare an existing repository with Custy, review generated resources, validate readiness, and preview a pipeline.

Commandcusty init

Category

Getting Started

Quick Command

custy init && custy validate
initializevalidatedry run
Starting Point
Existing repository
First Write
Project resources
Readiness Check
custy validate
First Pipeline Action
Dry-run preview

Overview​

This quick start prepares a repository without immediately creating commits, tags, or remote updates. Initialization writes project resources, validation checks readiness, and the final pipeline command uses global dry-run mode.

Before You Begin

Before You Begin

  • Custy is installedRequired

    custy --version resolves from the intended Python environment or container.

  • The project is under GitRequired

    git status reports the repository and branch you intend to manage.

  • Important work is recoverableRequired

    Commit, stash, or back up work that should not be mixed with onboarding changes.

  • You understand the configured remoteRequired

    A later pipeline can push, so verify remote names and destinations before normal execution.

Confirm the project
bash
pwd
git status --short --branch
git remote -v
custy --version

Initialize Custy

Run the default initialization mode, then inspect everything it added or skipped.

Initialize and inspect
bash
custy init
git status --short

The default all mode can create configuration, templates, example resources, and a version file. Existing files are preserved unless force behavior is selected. If an examples directory already exists, Custy still adds missing nested packaged examples without replacing existing example files.

Review These Resources

Configuration

Review .config/custy/config.toml. Set the changelog repository browser URL only if comparison links are needed, and verify every configured Git remote name.

Message Templates

Check the generated commit and tag message templates before a Git operation uses them.

Changelog Template

Review the changelog template before generating release notes.

Version File

Confirm that the generated or configured version-file path matches your project layout.
Review repository links and remotes
bash
git remote -v

# Edit .config/custy/config.toml, then validate it.

custy validate

Validate the Repository

Run validation after reviewing the generated project workspace.

Run the readiness checks
bash
custy validate

Validation checks repository state and workflow prerequisites such as required files, configuration, version resources, staged changes, and remotes. Resolve reported failures before moving to a pipeline.

Preview a Pipeline

Use the global --dry-run option before the command name. The following preview resolves the public Dev profile without intentionally applying its normal file, commit, and push effects.

Preview daily development
bash
custy --dry-run run dev

Quick-Start Flow

Workflow Timeline

1
Confirm repository
Verify the current directory, branch, working tree, and remotes.
completed
2
Initialize resources
Generate configuration, templates, examples, and version resources.
completed
3
Review generated files
Keep, customize, or deliberately remove resources before continuing.
completed
4
Validate readiness
Resolve failed checks before pipeline execution.
completed
5
Preview Dev
Inspect the dry-run output and documented side effects.
current

Continue

Related Commands

Commands commonly used together with this command.

Installation

Choose private GitLab, source, artifact, Git, or Docker installation.

custy init

Review initialization modes and generated files.