docs: Add bhelper alias usage guide

Added USING-BHELPER-ALIAS.md with: - Alias configuration details - Quick start examples - Tips for effective usage - All feature demonstrations Alias updated in ~/.bashrc to point to new location. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-27 21:06:01 -07:00
parent 13cb6029c7
commit bc3197ad8f
1 changed files with 182 additions and 0 deletions
@@ -0,0 +1,182 @@
+# Using the `bhelper` Alias
+
+## Alias Configuration
+
+Your bash alias has been updated to use the new Bash Buddy script:
+
+```bash
+alias bhelper='/home/dell/coding/gitea-projects/bash-buddy/bash-helper.sh'
+```
+
+**Location:** `~/.bashrc`
+
+## Activating the Alias
+
+To use the updated alias in your current terminal session:
+
+```bash
+source ~/.bashrc
+```
+
+Or simply open a new terminal - the alias will be available automatically.
+
+## Quick Start
+
+Now you can use `bhelper` as a shortcut for all Bash Buddy features:
+
+### Natural Language Queries
+
+```bash
+bhelper ask "find large files"
+bhelper task "compress a folder"
+bhelper ask "search text in files"
+```
+
+### Browse by Category
+
+```bash
+bhelper category files
+bhelper category network
+bhelper category system
+bhelper category text
+```
+
+### Explain Commands
+
+```bash
+bhelper explain "tar -czf archive.tar.gz folder/"
+bhelper explain "find . -name '*.txt'"
+```
+
+### Original Modes (Still Work)
+
+```bash
+bhelper ls size              # Direct flag lookup
+bhelper                      # Interactive fzf mode
+bhelper --help               # Show help with ASCII banner
+bhelper --list               # List all commands
+```
+
+## Examples
+
+### 1. Quick Command Lookup
+
+```bash
+$ bhelper ask "disk usage"
+
+Searching for: "disk usage"
+
+Found 5 matches:
+
+1. Show disk usage of directories
+   du -sh */
+
+2. Find files larger than 100MB
+   find . -type f -size +100M -exec ls -lh {} \;
+...
+```
+
+### 2. Learn New Commands
+
+```bash
+$ bhelper category files
+
+Category: File Operations
+
+1. List files sorted by size (largest first)
+   ls -lhS
+
+2. Find files larger than 100MB
+   find . -type f -size +100M -exec ls -lh {} \;
+...
+```
+
+### 3. Understand Command Flags
+
+```bash
+$ bhelper explain "tar -czf archive.tar.gz folder/"
+
+Command: tar -czf archive.tar.gz folder/
+
+Description: Compress a folder into tar.gz archive
+
+Flag explanations:
+  -c : Create archive
+  -z : Compress with gzip
+  -f : File name follows
+```
+
+## Features
+
+- **Fast**: All queries return in <100ms
+- **Local**: No internet required
+- **Smart**: Understands natural language
+- **Helpful**: Shows examples and explanations
+- **Professional**: ASCII banner and color-coded output
+
+## Help System
+
+View complete help anytime:
+
+```bash
+bhelper --help
+```
+
+Shows:
+- ASCII banner
+- Quick start guide
+- All available modes
+- Examples for each feature
+- Requirements and dependencies
+
+## Tips
+
+1. **Use quotes for multi-word queries:**
+   ```bash
+   bhelper ask "find large files"  # ✓ Correct
+   bhelper ask find large files    # ✗ Will only search "find"
+   ```
+
+2. **Browse categories to discover commands:**
+   ```bash
+   bhelper category files    # See all file operations
+   ```
+
+3. **Explain any command you're curious about:**
+   ```bash
+   bhelper explain "any bash command here"
+   ```
+
+4. **Original direct lookup still works:**
+   ```bash
+   bhelper ls size    # Quick flag reference
+   ```
+
+## Version
+
+**Bash Buddy v2.0.0** - Phase 1 Complete
+
+With natural language queries, 20-task database, and intelligent search!
+
+## Repository
+
+All code is version-controlled and pushed to Gitea:
+
+**URL:** http://localhost:3030/trill-technician/bash-buddy
+
+**Latest commits:**
+- `13cb602` - docs: Add Phase 1 live demo with examples and benchmarks
+- `7f00dfe` - feat: Phase 1 - Add intelligent natural language query system with ASCII banner
+- `effbd8e` - feat: Add CLI parameter support for direct command lookup
+
+## Enjoy!
+
+You now have a powerful, intelligent CLI assistant at your fingertips with just one command: **`bhelper`**
+
+Try it now:
+```bash
+source ~/.bashrc
+bhelper ask "compress folder"
+```
+
+🚀 Happy scripting!