-
-
Notifications
You must be signed in to change notification settings - Fork 0
Command Line Options
Youri Theodora Kopoulos Kirchner Mattar edited this page Jan 13, 2026
·
2 revisions
hideDot supports the following command line options:
| Flag | Short | Description |
|---|---|---|
--config |
-c |
Path to config file (default: hidedot.conf.yaml) |
--profile |
-p |
Only apply configs matching this profile |
--dry-run |
-n |
Show what would be done without making changes |
--verbose |
-v |
Enable verbose output with debug info |
--quiet |
-q |
Only show errors |
--no-color |
Disable colored output | |
--no-backup |
Disable automatic backups |
| Command | Description |
|---|---|
link |
Create symlinks from config (default) |
status |
Show status of all symlinks (OK, MISSING, BROKEN, MISMATCH) |
unlink |
Remove symlinks (use --restore to restore backups) |
backup create |
Manually create backups of all linked files |
backup list |
List available backups |
# Use default config file (runs link command)
hidedot
# Explicitly run link command
hidedot link
# Specify custom config file
hidedot --config ~/custom-config.yaml
# Preview changes without applying them
hidedot --dry-run
# Apply only work profile configs
hidedot --profile work
# Verbose output for debugging
hidedot -v
# Check status of all symlinks
hidedot status
# Remove all symlinks
hidedot unlink
# Remove symlinks and restore original files from backup
hidedot unlink --restore
# Create manual backups
hidedot backup create
# List all available backups
hidedot backup list
# Combine options
hidedot -c ~/dotfiles/config.yaml -p personal -n -vMade with ❤️ in Go. Keep your dotfiles organized!
Licensed under GPL-3.0