A macOS menu bar application that makes managing local Redis instances simple and convenient. Start, stop, and configure Redis with a single click.
---
## Overview
Redis Menu sits in your macOS menu bar, providing easy access to start, stop, and configure Redis instances. Designed for developers who need to work with Redis locally and want a straightforward way to manage the database without terminal commands.
---
## Features
- **Menu Bar Controls**: Start and stop Redis with a single click
- **Visual Status Indicator**: Instantly see if Redis is running
- **Custom Configuration**: Configure data directory, log path, and port
- **Auto-start Options**: Start Redis automatically when the app launches
- **Launch at Login**: Start Redis Menu when your Mac boots
- **Lightweight Footprint**: Minimal resource usage in the background
---
## Requirements
- macOS 15.0 (Sequoia) or later
- Admin privileges (for first-time setup)
---
## Installation
### Build from Source
1. Clone the repository:
```bash
git clone https://github.com/maquina-app/redis-menu.git
cd redis-menu
```
2. Run the build script:
```bash
./build.sh
```
The build script will:
- Download and compile Redis if needed
- Build the application
- Place the built app in `build/Release/RedisMenu.app`
3. Move the built app to your Applications folder
### Build Requirements
- Xcode 16.0 or later
- Command Line Tools for Xcode
- macOS 15.0 (Sequoia) or later
---
## Usage
1. Click the Redis icon in the menu bar to see status and control options
2. Use "Start Redis" or "Stop Redis" to control the service
3. Click "Preferences" to configure settings:
- Data directory location
- Log file path
- Redis port (default: 6379)
- Auto-start options
- Launch at login option
---
## Configuration
### Default Locations
Redis Menu stores data in these default locations:
| Setting | Default Path |
|---------|-------------|
| Data directory | `~/.local/share/redis/data` |
| Log file | `~/.local/state/redis/logs/redis.log` |
| Port | 6379 |
All locations can be customized in the app preferences.
### Bundled Redis
Redis Menu downloads, compiles, and bundles Redis binaries for your Mac. You don't need to install Redis separately. The app handles downloading and compiling the appropriate Redis source code for your system.
---
## Troubleshooting
### Redis Won't Start
- Check if the port is already in use by another application
- Ensure you have write permissions to the data directory and log path
- Check the log file for specific error messages
### App Won't Launch
- Make sure you have macOS Sequoia (15.0) or later installed
- Try rebuilding from source using the build script
---
## Next Steps
