Safety and Side Effects

🚀Safety and Side Effects

Required Review

Understand what Custy can read, write, stage, publish, and request before executing a consequential operation.

Commandcusty --dry-run COMMAND

📦Category

Core Concepts

🚀Quick Command

custy --dry-run COMMAND [OPTIONS]

---

risk modelrecoveryverification

---

✅

Lowest Effect

Reads and validation

🌿

Local Effects

Files and Git history

🌐

External Effect

Remote synchronization

💻

Best First Step

Dry-run preview

Overview

Custy ranges from inspection and validation to project-file generation, Git history creation, and remote publication. Safety begins by choosing the smallest suitable command, understanding its complete effect set, previewing supported mutations, and verifying state after execution.

ℹ️Dry-run separates discovery from mutation

During dry-run, Custy may still read configuration and project files, inspect repository history, branches, tags, and remotes, validate inputs, and render previews. Intended file changes, editor launches, Git mutations, and remote mutations are simulated. Diagnostic logging can still write to Custy's log destination.

ℹ️Profiles inherit every included effect

A pipeline profile can include many direct-operation behaviors. When multiple public profiles are combined, treat their requirements and side effects as a union even though overlapping steps are deduplicated.

---

Effect Categories

✨What Custy Can Affect

✅Reads and Validation

Inspect configuration, files, repository state, history, tags, branches, and remotes.

📄Project Files

Generate resources, update versions and changelogs, edit messages, and create or remove retained backups.

📦Git Index

Stage selected tracked or untracked project changes before a commit.

🌿Local Git History

Create commits and tags that become part of the repository's local history.

🌐Remote State

Push HEAD and optional tag references to one or more resolved remotes.

💻Interactive Decisions

Open editable artifacts or request confirmation when a flow requires human review or destination selection.

---

Risk Increases with Scope

📋Properties

Property	Type	Description	Default	Required
Inspection and validation	Repository-aware	Reads real project and Git state. A validation command can still fail and optional command flags may add effects.	-	No
Project-file operations	Local mutation	Can create, replace, edit, move, or remove files according to the selected command and configuration.	-	No
Commit and tag operations	Local history	Create durable Git objects and references that require deliberate recovery if they are wrong.	-	No
Push operations	External mutation	Make branch or tag state visible at resolved remotes and may affect other people or automation.	-	No
Release and Full profiles	Combined scope	Coordinate file, index, history, tag, and remote effects; Full also invokes experimental finalization.	-	No

---

Before Normal Execution

📌Before You Begin

• Choose the smallest operationRequired

  Prefer a focused command or narrower profile when it reaches the same intended result.

• Inspect repository stateRequired

  Review the working tree, current branch, local tags, and configured remotes.

• Review project configurationRequired

  Confirm paths, templates, strategy, retention, Git, and remote settings.

• Run a supported dry previewRequired

  Read every resolved value, planned step, file, tag, and destination.

• Prepare recovery informationRequired

  Keep intentional changes backed up and know which files or Git references may need recovery.

• Confirm credentials and destinationsRequired

  Make sure the selected identity and every remote belong to the intended project.

Pre-execution inspection

bash

git status --short
git branch --show-current
git tag --list
git remote -v

custy --dry-run run dev

---

After Execution or Failure

📌Before You Begin

• Inspect project filesRequired

  Review generated content and the complete working-tree diff.

• Inspect the Git indexRequired

  Confirm which changes remain staged or unstaged.

• Inspect local historyRequired

  Verify the latest commit and every newly created tag.

• Inspect each remoteRequired

  Confirm which branch and tag updates actually reached each destination.

• Resume from observed stateRequired

  Do not repeat a multi-step profile until you know exactly which earlier stages completed.

---

🛡️Remote effects deserve separate review

Local recovery does not automatically undo a remote push. When an operation can publish changes, verify the remote name, URL, branch, tag, credentials, and multi-remote behavior before normal execution.

---

Continue

🚀Related Commands

Commands commonly used together with this command.

Dry Run

Understand what the simulation suppresses and what still runs.

Run Safety

Review profile-specific file, Git, prompt, and remote effects.

Validate

Check repository readiness before consequential operations.

Push

Review remote resolution and synchronization behavior.