diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index 88aa63d..ee91e30 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -243,13 +243,13 @@ cd ~ && git clone .dotfiles && cd .dotfiles && ./install.sh ### Verify Installation ```bash # Check dotfiles status -dotstatus +dot sync status # Check installed packages -dotpkgs +dot packages # Check machine profile -dotprofile +dot profile ``` ### Test Key Features @@ -312,7 +312,7 @@ DOTFILES_SKIP_GITHUB=true ./install.sh DOTFILES_SKIP_NPM=true ./install.sh # Install manually later: -dotinstall +dot packages install ``` #### Shell Not Supported @@ -337,13 +337,13 @@ cat ~/.dotfiles/.profile.log ```bash # If installation fails partway through: # 1. Check what was installed -dotpkgs +dot packages # 2. Try installing missing packages dotcheck # 3. Or reset and start over -dotreset --soft +dot reset --soft ./install.sh ``` @@ -394,7 +394,7 @@ After successful installation: 1. **Learn the commands**: [Configuration Reference](CONFIGURATION.md) 2. **Customize settings**: Edit files in `~/.dotfiles/shared/` 3. **Set up sync**: Configure git credentials for automatic sync -4. **Explore features**: Try `dotupdatecheck`, `dotprofile`, `dotstatus` +4. **Explore features**: Try `dot packages check-updates`, `dot profile`, `dot sync status` --- diff --git a/docs/ONE_LINE_INSTALL.md b/docs/ONE_LINE_INSTALL.md index 7af9114..89406dc 100644 --- a/docs/ONE_LINE_INSTALL.md +++ b/docs/ONE_LINE_INSTALL.md @@ -69,13 +69,13 @@ curl -fsSL https://raw.githubusercontent.com/your-username/dotfiles/main/install ### Verify Everything Works ```bash # Check system status -dotstatus +dot sync status # Check your profile -dotprofile +dot profile # Check installed packages -dotpkgs +dot packages # Try some shortcuts l # Enhanced file listing diff --git a/docs/README.md b/docs/README.md index 781c475..84a5285 100644 --- a/docs/README.md +++ b/docs/README.md @@ -96,30 +96,39 @@ The system automatically detects and configures based on machine type: ## 🎮 Command Interface -### Core Commands +The system uses an intuitive `dot [subaction] [flags]` command structure: + ```bash # Installation and setup ./install.sh # Initial setup with profile detection -dotstatus # Show sync status and last update -dotsync # Manual sync now -dotprofile # Show current machine profile +dot help # Show all available commands +dot version # Show version information -# Package management -dotpkgs # Show package status for current profile -dotinstall # Install all packages for current profile -dotupdatecheck # Check for package updates (fast) -dotupdate # Install pending updates +# Sync Management +dot sync # Manual sync now +dot sync --force # Force sync (ignore timing limits) +dot sync status # Show sync status and last update +dot sync on # Enable automatic syncing +dot sync off # Disable automatic syncing -# Profile management -dotprofileset server # Switch to server profile -dotprofiledetect # Re-detect machine type -dotprofile # Show current profile status +# Package Management +dot packages # Show package status for current profile +dot packages install # Install all packages for current profile +dot packages check # Check package installation status +dot packages update # Install pending updates +dot packages check-updates # Check for package updates (fast) +dot packages status # Show update status -# Reset and cleanup -dotreset # Interactive reset menu -dotresetsoft # Remove configs, restore originals -dotresethard # Soft reset + uninstall packages -dotresetnuke # Complete removal (back to vanilla) +# Profile Management +dot profile # Show current machine profile +dot profile set # Switch to specified profile (server/dev/personal) +dot profile detect # Re-detect machine type + +# Reset and Cleanup +dot reset # Interactive reset menu +dot reset --soft # Remove configs, restore originals +dot reset --hard # Soft reset + uninstall packages +dot reset --nuclear # Complete removal (back to vanilla) ``` ### Universal Aliases (Available on All Machines) @@ -348,8 +357,8 @@ exec $SHELL ### Customization ```bash # Change machine profile -dotprofileset dev-lite -dotinstall +dot profile set dev-lite +dot packages install # Add custom aliases vim ~/.dotfiles/shared/aliases @@ -362,16 +371,16 @@ git push ### Advanced Configuration ```bash # Disable auto-sync -dotsoff +dot sync off # Force profile re-detection -dotprofiledetect +dot profile detect # Check what packages would be installed -dotpkgs +dot packages # Reset to clean state -dotreset +dot reset ``` ## 🤝 Contributing