Skip to content

configuration.md

Latest commit

 

History

History
86 lines (58 loc) · 2.11 KB

configuration.md

File metadata and controls

86 lines (58 loc) · 2.11 KB

Configuration

All CustomRC configuration is managed in ~/.customrc/configs.sh.

Operating Modes

CustomRC supports two modes controlled by CUSTOMRC_DEBUG_MODE.

Debug Mode

Enable verbose output with per-module timing by setting CUSTOMRC_DEBUG_MODE=true:

[i] Initializing Customrc...
━━━━[customrc]━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
✓ Loaded: fzf.sh [Global] (3ms)
✓ Loaded: bat.sh [Global] (1ms)
✗ Ignored: nvm.sh [Global]
✓ Loaded: brew.sh [Darwin] (2ms)
━━━━[customrc]━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
[i] Initialization complete
    ✓ Loaded: 24
    ✗ Ignored: 5
    ⚠ Duration: 89ms

Use debug mode when:

  • Developing new modules
  • Troubleshooting slow startup times
  • Identifying which modules are being loaded

Production Mode

When CUSTOMRC_DEBUG_MODE=false (default), CustomRC generates a monolithic cache file combining all modules. This cache:

  • Auto-regenerates when any module or configs.sh changes
  • Sources instantly without per-file overhead
  • Lives at ~/.cache/customrc/monolithic.sh

Production mode is recommended for daily use.

Ignore Lists

Disable slow or unused modules by adding them to platform-specific ignore lists:

CUSTOMRC_GLOBAL_IGNORE_LIST=(
  "nvm.sh"       # 200ms+ - use fnm instead
  "thefuck.sh"   # 100ms+ - lazy load if needed
)

CUSTOMRC_DARWIN_IGNORE_LIST=(
  "iterm.sh"     # Not needed if using other terminal
)

CUSTOMRC_LINUX_IGNORE_LIST=()

Cache Management

Use the customrc cache CLI commands to manage caches. Run customrc cache status to view current cache information.

Clearing Caches

Use customrc cache clear to remove all caches, or specify a name to clear a specific one:

# Clear all caches
customrc cache clear

# Clear specific cache
customrc cache clear fzf

Caches are stored in ~/.cache/customrc/.

Force Regenerating Monolithic Cache

Use the CLI to rebuild the monolithic cache:

customrc cache rebuild

This forces regeneration of the monolithic cache file.