https://github.com/anubhavitis/homebrew-peeksy
screenshot name automation tool for macos
https://github.com/anubhavitis/homebrew-peeksy
homebrew open-source openai screenshot screenshot-utility vision-api
Last synced: about 1 month ago
JSON representation
screenshot name automation tool for macos
- Host: GitHub
- URL: https://github.com/anubhavitis/homebrew-peeksy
- Owner: anubhavitis
- Created: 2025-06-12T10:15:56.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-18T11:43:19.000Z (10 months ago)
- Last Synced: 2025-08-18T13:28:39.211Z (10 months ago)
- Topics: homebrew, open-source, openai, screenshot, screenshot-utility, vision-api
- Language: Ruby
- Homepage: https://anubhavitis.github.io/peeksy/
- Size: 71.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Peeksy
A Rust-based tool that automatically renames screenshots and images using OpenAI's GPT-4 Vision API. The tool analyzes image content and generates descriptive, meaningful filenames following a consistent naming convention.
Demo video [here](https://x.com/anubhavitis/status/1922303569639702976)
## Features
- Automatic image analysis using GPT-4 Vision API
- Intelligent context recognition (screenshots, album covers, artwork, posters, UI elements)
- Consistent filename formatting (lowercase, hyphen-separated)
- Real-time file monitoring and automatic renaming
- Configurable naming rules through prompt template
## Requirements
- Rust (latest stable version)
- OpenAI API key with access to GPT-4 Vision API
Note: Peeksy will prompt you to enter OpenApi key them during first run. The values will be automatically saved for future use.
## Installation
```
brew tap anubhavitis/peeksy
brew install peeksy
peeksy start
```
## How to Use
Once you've completed the installation steps above, Peeksy will automatically monitor your screenshots directory. Here's what happens:
1. **Start the Service**
```bash
peeksy start
```
2. **Take Screenshots**
- Use your system's screenshot shortcut (⌘⇧3 or ⌘⇧4 on macOS)
3. **Watch the Magic**
- Peeksy will detect new screenshots
- Analyze the content using GPT-4 Vision
- Automatically rename them with descriptive names
- Original files are preserved with the new names
4. **Customize (Optional)**
```bash
# View your current prompt template
peeksy view-prompt-file
# Update the prompt template
peeksy update-prompt-file-path "path/to/your/custom-prompt.txt"
```
That's it! Peeksy will continue running in the background, automatically renaming your screenshots as you take them.
## Commands
Peeksy provides several commands to manage the daemon and configuration:
### Daemon Management
- `start` - Start the Peeksy daemon
- `stop` - Stop the running Peeksy daemon
- `restart` - Restart the Peeksy daemon
- `status` - Check if the Peeksy daemon is running and get its PID
### Configuration Management
- `current-config` - Display the current configuration in JSON format
- `view-prompt-file` - Display the contents of the current prompt file
- `update-api-key ` - Update the OpenAI API key
- `update-prompt-file-path ` - Update the path to the prompt template file
### Examples
```bash
# Start the Peeksy daemon
peeksy start
# Check if the daemon is running and get its PID
peeksy status
# Stop the running daemon
peeksy stop
# Restart the daemon (useful after configuration changes)
peeksy restart
# View your current configuration settings
peeksy current-config
# View the contents of your prompt template file
peeksy view-prompt-file
# Update your OpenAI API key
peeksy update-api-key "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
# Update the path to your prompt template file
peeksy update-prompt-file-path "/path/to/your/custom-prompt.txt"
# Run the daemon directly (usually not needed, use 'start' instead)
peeksy daemon
```
Note: The daemon must be running for Peeksy to monitor and rename your screenshots. Use `peeksy status` to verify the daemon is running.
# Support & Queries
For any questions, issues, or feature requests, please reach out to:
- [Email](mailto:anubhavitis@gmail.com)
- GitHub Issues: [Create an issue](https://github.com/anubhavitis/peeksy/issues)
Feel free to:
- Report bugs
- Suggest new features
- Ask for help with configuration
- Share your experience with Peeksy