Documentation
CLI/config

renamed config

Manage configuration files. Create templates, validate syntax, and inspect active settings.

renamed config <command> [options]

The config command helps you manage YAML configuration files. Use config files to set default options, define watch patterns, and configure production deployments.

Subcommands

init

Create an example configuration file with all available options.

validate

Check a configuration file for syntax errors and invalid options.

show

Display the active configuration with all resolved values.

path

Show the paths where config files are searched for.

Examples

Create a local config file:

$ renamed config init

 Created ./.renamed.yaml with example configuration

Create a global config file:

$ renamed config init --global

 Created ~/.config/renamed/config.yaml

Validate a config file:

$ renamed config validate --config ./my-config.yaml

 Configuration is valid

Show active configuration:

$ renamed config show

Show config file locations:

$ renamed config path

Config file locations (in priority order):
 1. ./.renamed.yaml
 2. ~/.config/renamed/config.yaml
 3. /etc/renamed/config.yaml

Options

-g, --global

For init: create in global config directory (~/.config/renamed/).

-c, --config <path>

For validate and show: specify a config file path.

Example Configuration

~/.config/renamed/config.yaml
# Default rename settings
rename:
 template: date_first
 strategy: by_type
 language: en

# Watch mode configuration
watch:
 patterns:
 - "*.pdf"
 - "*.jpg"
 - "*.png"

# Rate limiting
rateLimit:
 concurrency: 4
 retryAttempts: 3

# Health monitoring
health:
 enabled: true
 socketPath: /tmp/renamed.sock

Config File Locations

./.renamed.yaml — Project-local configuration (highest priority)

~/.config/renamed/config.yaml — User-level configuration

/etc/renamed/config.yaml — System-wide configuration (lowest priority)

Settings are merged with local configs taking precedence over global ones.

See Also