https://github.com/radiosilence/go-brew-search
⚡ Lightning-fast Homebrew package search with local caching and interactive UI
https://github.com/radiosilence/go-brew-search
ai-generated cli fuzzy-search go homebrew package-manager terminal
Last synced: 29 days ago
JSON representation
⚡ Lightning-fast Homebrew package search with local caching and interactive UI
- Host: GitHub
- URL: https://github.com/radiosilence/go-brew-search
- Owner: radiosilence
- Created: 2025-05-26T12:25:54.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-05-26T12:57:09.000Z (4 months ago)
- Last Synced: 2025-06-26T10:59:02.119Z (3 months ago)
- Topics: ai-generated, cli, fuzzy-search, go, homebrew, package-manager, terminal
- Language: Go
- Homepage: https://github.com/radiosilence/go-brew-search
- Size: 26.4 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🍺 go-brew-search
> **🤖 AI Experiment**: This project was entirely generated through a conversation with Claude 4 Opus. It serves as an experiment in AI-assisted software development.
A blazing-fast, interactive Homebrew package search tool with local caching. Say goodbye to slow `brew search` commands!
## ✨ Features
- **⚡ Lightning Fast**: Uses local caching to provide instant search results
- **🔍 Fuzzy Search**: Interactive fzf-style interface for easy package discovery
- **📊 Rich Display**: Shows package names, versions, and descriptions in a clean table format
- **✅ Multi-Select**: Select multiple packages at once with TAB
- **🎯 Smart Integration**: Automatically adds selected packages to your `~/Brewfile`
- **🚀 Auto-Install**: Runs `brew bundle` after selection to install packages
- **⚡ Direct Install**: Use `--immediate` flag to install without Brewfile
- **📝 Status Tracking**: Shows which packages are already in your Brewfile
- **🎨 Beautiful UI**: Uses emojis and colors for better visual feedback
## 📦 Installation
### Prerequisites
- Go 1.21 or later
- Homebrew installed
- A terminal that supports Unicode (for emojis)
- [Task](https://taskfile.dev) - Task runner for build automation
#### Installing Task
If you don't have Task installed, you can use our helper script:
```bash
./install-task.sh
```
Or install manually:
- macOS: `brew install go-task/tap/go-task`
- Linux: See [installation guide](https://taskfile.dev/installation/)
### Build from Source
```bash
# Clone the repository
git clone https://github.com/yourusername/go-brew-search.git
cd go-brew-search
# Build the binary
task build
# Option 1: Install system-wide
task install
# Option 2: Install to ~/.local/bin
task install-local
# Option 3: Add to PATH
export PATH="$PWD:$PATH"
```
### Quick Install (using go install)
```bash
go install github.com/yourusername/go-brew-search/cmd@latest
mv $GOPATH/bin/cmd $GOPATH/bin/brew-search
```
## 🚀 Usage
### Default Mode (Brewfile)
```bash
brew-search
```
This will update your `~/Brewfile` and run `brew bundle`.
### Immediate Mode (Direct Installation)
```bash
brew-search --immediate
```
This will install selected packages directly without updating your Brewfile.
### Interactive Controls
- **Type** to search packages
- **↑↓** to navigate
- **TAB** to select/deselect packages
- **ENTER** to confirm selection
- **ESC** to cancel
### Package Icons
- 📦 Formula (regular Homebrew packages)
- 🍺 Cask (GUI applications)
- ✓ Already in Brewfile
## 🔧 How It Works
1. **Caching**: On first run, fetches all package data from Homebrew's API and caches it locally
2. **Search**: Provides instant fuzzy search through the cached data
3. **Selection**: Shows an interactive interface with package details
4. **Brewfile Management**: Adds selected packages to `~/Brewfile` with proper formatting (unless using `--immediate`)
5. **Installation**: Automatically runs `brew bundle` or direct `brew install` to install the selected packages
## 📁 Cache Management
The tool caches Homebrew package data in `~/.cache/go-brew-search/`. The cache expires after 24 hours.
To clear the cache manually:
```bash
rm -rf ~/.cache/go-brew-search
```
## ⚙️ Configuration
Currently, the tool uses sensible defaults:
- **Cache Location**: `~/.cache/go-brew-search/`
- **Cache TTL**: 24 hours
- **Brewfile Location**: `~/Brewfile`
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
### Development
```bash
# Show all available tasks
task
# Run tests
task test
# Run tests with coverage
task test-coverage
# Build the binary
task build
# Build and run
task run
# Format code
task fmt
# Run linters
task lint
# Run all checks (fmt, lint, test)
task check
# Build release binaries for multiple platforms
task release
# Clean build artifacts
task clean
# Clear the package cache
task clean-cache
# Run the interactive demo
task demo
```
## 📝 License
MIT License - feel free to use this tool however you like!
## 🐛 Known Issues
- The tool requires a terminal that supports Unicode for emoji display
- Initial cache population might take a few seconds on first run
- Some casks might not have complete metadata
## 🎯 Motivation
The built-in `brew search` command is notoriously slow because it queries the API every time. This tool solves that problem by:
1. Caching all package data locally
2. Providing instant fuzzy search
3. Offering a better UI with multi-select
4. Automating the Brewfile workflow
Never wait for `brew search` again! 🚀