CLI Reference

🚀CLI Reference

Active Public CLI

See the active command tree and open the detailed guide for each operation.

Commandcusty COMMAND [ARGS]...

📦Category

Reference

🚀Quick Command

custy [GLOBAL_OPTIONS] COMMAND [COMMAND_OPTIONS]

---

Typerdirect commandscommand groups

---

💻

Installed Entrypoint

custy

🐍

Module Entrypoint

python -m app

🚀

Direct Commands

6

📁

Command Groups

6

Syntax

Global options belong before the selected command. Options owned by a command or subcommand follow that name.

CLI shape

bash

custy [GLOBAL_OPTIONS] COMMAND [COMMAND_OPTIONS]
custy [GLOBAL_OPTIONS] GROUP SUBCOMMAND [SUBCOMMAND_OPTIONS]

# Equivalent source-checkout entrypoint

python -m app [GLOBAL_OPTIONS] COMMAND [COMMAND_OPTIONS]

---

Direct Commands

ℹ️Root Operations

custy init	Create or replace project configuration, templates, examples, and a version file. Open Init docs.
custy validate	Run the complete project-readiness profile. Open Validate docs.
custy commit	Run the prepared commit pipeline. Open Commit docs.
custy tag	Prepare version artifacts and create a local Git tag. Open Tag docs.
custy push	Push the resolved branch and optional tag to configured remotes. Open Push docs.
custy run	Resolve one or more supported public profiles into an ordered pipeline. Open Run docs.

---

Command Groups

ℹ️Grouped Operations

custy changelog generate	Generate CHANGELOG.md through the active semantic changelog system. Open Changelog docs.
custy version update	Resolve and apply a compatible version to the configured version file. Open Version docs.
custy backup commit | tag | all	Back up one or both message templates. Open Backup docs.
custy cleanup backups | branches | all	Remove retained backup files, eligible branches, or both. Open Cleanup docs.
custy configure credentials	Configure, inspect, test, or remove optional external HTTPS credential fallback. Open Configure Credentials docs.
custy workflow branch	Evaluate or enforce branch and tag transitions through the experimental workflow surface. Open Workflow warning.

⚠️Workflow is experimental

The workflow branch route is registered, but its feature set is incomplete and should be evaluated only in a disposable repository until the documented limitations are resolved.

---

Run Profile Boundary

The typed custy run argument accepts commit, tag, push, dev, release, and full. Other names in PIPELINE_PROFILES support direct commands or internal composition and are not additional public Run values.

See Pipeline Profiles for the compact index and Complete Profile Reference for all expanded steps.

---

Continue

🚀Related Commands

Commands commonly used together with this command.

Command Guide

Open detailed syntax, options, output, examples, and troubleshooting.

Global Options

Review the six options parsed by the root callback.

Pipeline Profiles

Distinguish public Run values from internal resolver profiles.

CLI Architecture

Trace entrypoints, registration, models, resolvers, and AppContext.