Skip to main content

Command Reference

Overview​

Custy provides focused commands for individual operations and a run command for supported multi-step pipeline profiles. Choose a command based on the result you need, then review its requirements and side effects before execution.

Available Command Groups

Public Command Reference

Initialize and Validate

Use Init to prepare project resources and Validate to check readiness.

Backup and Cleanup

Use Backup to retain message files and Cleanup for reviewed pruning.

Commit and Tag

Use Commit to prepare local history and Tag for reviewed version tags.

Push and Run

Use Push for remote synchronization and Run for public profiles.

Configure Credentials

Use Configure Credentials to prepare optional, external HTTPS token fallback without storing tokens in the project configuration.

Experimental Workflow

The Workflow group is experimental and currently blocked by a documented source mismatch.

Direct Commands and Pipeline Profiles

A direct command performs one focused responsibility. For example, custy changelog generate generates the changelog and custy push synchronizes selected Git references.

The custy run command coordinates registered public profiles. The currently accepted profile names are:

  • commit
  • tag
  • push
  • dev
  • release
  • full

Profiles may combine validation, file editing, version changes, changelog generation, backups, cleanup, staging, commits, tags, pushes, or workflow finalization. Each profile page will show its resolved sequence and side effects.


Global Options

Global options such as dry-run, debug output, and log-level selection belong to the root custy command. Their exact effect can vary by operation, so each command page explains whether an action is previewed, skipped, or still requires care.