Peeksy Documentation

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.

Watch Demo Video

Installation

Requirements

OpenAI API key with access to GPT-4 Vision API

Note: Peeksy will prompt you to enter OpenApi key during first run. The values will be automatically saved for future use.

Quick Installation (Recommended)

# Install using Homebrew
brew tap anubhavitis/peeksy
brew install peeksy

# Start the daemon
peeksy start

Manual Installation

Note: Make sure you have Rust installed on your system. If not, install it from rustup.rs.

# Clone the repository
git clone https://github.com/anubhavitis/peeksy.git
cd peeksy

# Build the project
cargo build --release

# Install the binary
sudo cp target/release/peeksy /usr/local/bin/

# Start the daemon
peeksy start

# Verify the installation
peeksy status
peeksy current-config

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

How to Use

Basic Usage

Start the Service
```
peeksy start
```
Take Screenshots using your system's screenshot shortcut (⌘⇧3 or ⌘⇧4 on macOS)
Watch the Magic - Peeksy will automatically detect, analyze, and rename your screenshots

Customization

# View your current prompt template
peeksy view-prompt-file

# Update the prompt template
peeksy update-prompt-file-path "path/to/your/custom-prompt.txt"

Commands

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 <value> - Update the OpenAI API key
update-prompt-file-path <value> - Update the path to the prompt template file

Examples

# 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:

Feel free to:

Report bugs
Suggest new features
Ask for help with configuration
Share your experience with Peeksy

Special Thanks

A heartfelt thank you to:

navedux for creating the beautiful Peeksy logo and identity