renamify init

The init command adds .renamify/ to ignore files to prevent tracking of Renamify’s workspace files.

Usage

renamify init [OPTIONS]

Options

• --local - Add to .git/info/exclude instead of .gitignore
• --global - Add to global git excludes file
• --check - Check if .renamify is ignored (exit 0 if yes, 1 if no)
• --configure-global - Configure global excludes file if it doesn’t exist (requires --global)

Examples

Initialize Repository Ignore

# Add .renamify/ to .gitignore (most common)
renamify init

Local-Only Ignore

# Add to .git/info/exclude (not committed)
renamify init --local

Global Ignore

# Add to global git excludes file
renamify init --global --configure-global

Check Status

# Check if .renamify is already ignored
renamify init --check
echo $?  # 0 if ignored, 1 if not

Auto-Initialization

Renamify automatically prompts to initialize on first use:

Renamify uses .renamify/ for plans, backups, and history.
Ignore it now?
  [Y] Repo .gitignore   [l] Local .git/info/exclude   [g] Global excludesfile   [n] No
Choice (Y/l/g/n): Y

Disable Auto-Init

# Prevent automatic initialization prompts
renamify --no-auto-init plan old new

# Force automatic repo initialization
renamify --auto-init=repo plan old new

Why Initialize?

The .renamify/ directory contains:

• Plans: plan.json files with renaming details
• Backups: Complete backups of modified files
• History: history.json with operation records

These are workspace files that shouldn’t be committed to version control.