Skip to main content

Custy

Interface
Command-Line Application
Primary Domain
Git and Releases
Configuration
.config/custy/config.toml
Documentation Language
English

Custy at a Glance

Custy terminal banner and Git workflow output
A representative Custy terminal workflow. The final release screenshot can be added without changing this page.

Overview​

Custy is a configurable developer-productivity CLI for managing repeatable Git and release work. It brings project validation, version updates, changelog generation, backups, cleanup, commits, tags, pushes, and multi-step pipelines into one consistent interface.

What Custy Helps You Manage

Use individual commands for focused tasks or public pipeline profiles for coordinated development and release work.

Core Capabilities

Project Readiness

Initialize project resources and validate repositories before consequential operations begin.

Version and Changelog

Prepare versions and generate structured changelogs from repository history and project configuration.

Git Operations

Create commits and tags, then synchronize branches and tags with configured remotes.

Reusable Pipelines

Run supported development, release, and full profiles with a predictable ordered workflow.

Safety and Recovery

Create message backups, preview supported operations, and clean retained files or branches deliberately.

Project Configuration

Customize paths, templates, Git behavior, versioning, changelog output, cleanup, and logging.

Start Here

The Getting Started guide takes you from installation to a reviewed pipeline preview. Use the command documentation when you need detailed options, side effects, examples, output, and troubleshooting guidance. Use the Configuration guide to understand project-owned defaults, paths, templates, Git remotes, changelog behavior, and logging. Use the Pipeline guide to understand profile resolution, execution boundaries, and contributor-facing step internals. Use the User Guide for task-oriented development, release, maintenance, and recovery journeys. Use the Developer Guide to set up the source checkout, test changes, and extend commands, pipelines, version strategies, or configuration safely. Use the Architecture guide to trace those features through the CLI, core services, Git boundary, pipelines, workflow engine, strategies, and changelog subsystem. Use the Reference when you need an exact command name, global option, version form, pipeline profile, path, environment requirement, or exit-status note without reading a longer guide. Use the Troubleshooting hub to route a failure to Git, configuration, versioning, changelog, or workflow diagnosis and recover from partial state safely.

Common starting points
bash
# Prepare project-specific Custy resources
custy init

# Check whether the repository is ready

custy validate

# Inspect the public pipeline profiles

custy run --help

Choose the Smallest Suitable Operation

  • Use a direct command when you need one focused operation.
  • Use custy run dev, custy run release, or custy run full when you need a coordinated pipeline.
  • Review the documented side effects before running a profile that can edit files, create Git history, or communicate with remotes.
  • Use dry-run support where the selected command or workflow provides it.

The custy workflow command group is experimental. Its documentation is kept separate from the stable pipeline profiles and clearly identifies current limitations.